diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index 509fba742..4522c6ef2 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -31,7 +31,7 @@ jobs: - name: Install mdbook & plugins uses: taiki-e/install-action@v2.18.6 with: - tool: mdbook@0.4.34,mdbook-admonish@1.11.1,mdbook-linkcheck@0.7.7,mdbook-mermaid@0.12.6,mdbook-template@1.1.0 + tool: mdbook@0.4.34,mdbook-admonish@1.11.1,mdbook-linkcheck@0.7.7,mdbook-mermaid@0.12.6,mdbook-template@1.1.0,mdbook-emojicodes@v0.3.0 - name: Setup Pages id: pages uses: actions/configure-pages@v3 diff --git a/README.md b/README.md index 43c3b3a9c..f6a250619 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,7 @@ The following `mdbook` features & plugins are available and in use: - `mdbook-linkcheck` - `mdbook-template` - `mdbook-admonish` +- `mdbook-emojicodes` The site is currently hosted at [https://spacestation14.io/docs/](https://spacestation14.io/docs/). This will likely change in the future, so links here should not be relied on. diff --git a/book.toml b/book.toml index 5c8e57f6f..a4ffec27d 100644 --- a/book.toml +++ b/book.toml @@ -11,8 +11,10 @@ description = "Tutorial & reference for all Space Wizards Federation projects, i [preprocessor.admonish] assets_version = "2.0.2" # do not edit: managed by `mdbook-admonish install` +[preprocessor.emojicodes] + [preprocessor.template] -before = ["mermaid", "admonish"] # templates can include these so we run this first +before = ["mermaid","admonish","emojicodes"] # templates can include these so we run this first [output.html] additional-js = ['scripts/mermaid.min.js', 'scripts/mermaid-init.js', 'scripts/nav-additions.js'] diff --git a/src/en/meta/guide-to-editing-docs.md b/src/en/meta/guide-to-editing-docs.md index bfabeb7ac..e43ce5713 100644 --- a/src/en/meta/guide-to-editing-docs.md +++ b/src/en/meta/guide-to-editing-docs.md @@ -36,6 +36,7 @@ From cargo, install: - `mdbook-template` - `mdbook-linkcheck` - `mdbook-admonish` +- `mdbook-emoji` Call `mdbook serve` to build and locally host the documentation from the `book` directory at `localhost:3000`. diff --git a/src/index.md b/src/index.md index 0f035fd1e..c8fb8662d 100644 --- a/src/index.md +++ b/src/index.md @@ -17,11 +17,10 @@ If you would like to make contributions to this documentation site, it's hosted ## Getting Started -- [❓ How do I code?](en/general-development/setup/howdoicode.md) -- [📦 Setting up the Dev Environment](en/general-development/setup/setting-up-a-development-environment.md) -- [🗺 Mapping](en/space-station-14/mapping.md) -- [📈 Git for the SS14 Developer](en/general-development/setup/git-for-the-ss14-developer.md) -- [🛠 Troubleshooting FAQ](en/general-development/tips/troubleshooting-faq.md) +- [:question: How do I code?](en/general-development/setup/howdoicode.md) +- [:package: Setting up the Dev Environment](en/general-development/setup/setting-up-a-development-environment.md) +- [:world_map: Mapping](en/space-station-14/mapping.md) +- [:chart_with_upwards_trend: Git for the SS14 Developer](en/general-development/setup/git-for-the-ss14-developer.md) ### What should I work on?