Skip to content

Commit 06c0aee

Browse files
committed
Fix README and API Docs
Motivation: The emojis in the README were not rendered consistently in the docs and on different screen form factors making a poor UX. Modifications: The CI config now properly sends the custom theme to Jazzy, and the README no longer has the `:bell:` emoji in the disclaimer header. Result: A consistent UX with the README and proper API docs referring to GitLab
1 parent 23a8d44 commit 06c0aee

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

.gitlab-ci.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ pages:
2323
--root-url "https://mordil.gitlab.io/swift-redis-nio-client/docs/RedisNIO" \
2424
--module "RedisNIO" \
2525
--module-version "$version" \
26-
--theme fullwidth \
26+
--theme docs/theme \
2727
--xcodebuild-arguments -scheme,swift-redis-nio-client-Package \
2828
--sourcekitten-sourcefile "./RedisNIO.json" \
2929
--output "./public"

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
| :bell: The [GitHub repository](https://github.com/Mordil/swift-redis-nio-client) is a **read-only** mirror of the GitLab repository. For issues and merge requests, [please visit GitLab](https://gitlab.com/mordil/swift-redis-nio-client). :bell: |
1+
| The [GitHub repository](https://github.com/Mordil/swift-redis-nio-client) is a **read-only** mirror of the GitLab repository. For issues and merge requests, [please visit GitLab](https://gitlab.com/mordil/swift-redis-nio-client). |
22
|---|
33

44
[![License](https://img.shields.io/badge/License-Apache%202.0-yellow.svg)](./LICENSE.txt)

0 commit comments

Comments
 (0)