Refactor repository structure to include translations

.env

@@ -1 +1,2 @@
 MDBOOK_VERSION=0.4.28
+MDBOOK_I8N_HELPERS_VERSION=0.1.0

.github/workflows/build.yml

@@ -0,0 +1,119 @@
+name: Test mdbook chapters
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+
+env:
+  CARGO_TERM_COLOR: always
+
+jobs:
+  mdbook-test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Setup Rust cache
+        uses: ./.github/workflows/setup-rust-cache
+
+      - name: Install mdbook
+        uses: ./.github/workflows/install-mdbook
+
+      - name: Test code snippets
+        run: mdbook test
+
+  # TODO: Activate when first translation is available
+  # i18n-helpers:
+  #   runs-on: ubuntu-latest
+  #   steps:
+  #     - name: Checkout
+  #       uses: actions/checkout@v3
+
+  #     - name: Install Gettext
+  #       run: sudo apt install gettext
+
+  #     - name: Setup Rust cache
+  #       uses: ./.github/workflows/setup-rust-cache
+
+  #     - name: Install mdbook
+  #       uses: ./.github/workflows/install-mdbook
+
+  #     - name: Generate po/messages.pot
+  #       run: mdbook build -d po
+  #       env:
+  #         MDBOOK_OUTPUT: '{"xgettext": {"pot-file": "messages.pot"}}'
+
+  #     - name: Test messages.pot
+  #       run: msgfmt --statistics -o /dev/null po/messages.pot
+
+  #     - name: Expand includes without translation
+  #       run: mdbook build -d expanded
+  #       env:
+  #         MDBOOK_OUTPUT: '{"markdown": {}}'
+
+  #     - name: Expand includes with no-op translation
+  #       run: mdbook build -d no-op
+  #       env:
+  #         MDBOOK_OUTPUT: '{"markdown": {}}'
+  #         MDBOOK_PREPROCESSOR__GETTEXT__PO_FILE: po/messages.pot
+
+  #     - name: Compare no translation to no-op translation
+  #       run: diff --color=always --unified --recursive expanded no-op
+
+  # find-translations:
+  #   runs-on: ubuntu-latest
+  #   outputs:
+  #     languages: ${{ steps.find-translations.outputs.languages }}
+  #   steps:
+  #     - name: Checkout
+  #       uses: actions/checkout@v3
+
+  #     - name: Find translations
+  #       id: find-translations
+  #       shell: python
+  #       run: |
+  #         import os, json, pathlib
+  #         languages = [p.stem for p in pathlib.Path("po").iterdir() if p.suffix == ".po"]
+  #         github_output = open(os.environ["GITHUB_OUTPUT"], "a")
+  #         github_output.write("languages=")
+  #         json.dump(sorted(languages), github_output)
+
+  # translations:
+  #   runs-on: ubuntu-latest
+  #   needs:
+  #     - find-translations
+  #   strategy:
+  #     matrix:
+  #       language: ${{ fromJSON(needs.find-translations.outputs.languages) }}
+  #   env:
+  #     MDBOOK_BOOK__LANGUAGE: ${{ matrix.language }}
+  #   steps:
+  #     - name: Checkout
+  #       uses: actions/checkout@v3
+
+  #     - name: Install Gettext
+  #       run: sudo apt install gettext
+
+  #     - name: Setup Rust cache
+  #       uses: ./.github/workflows/setup-rust-cache
+
+  #     - name: Install mdbook
+  #       uses: ./.github/workflows/install-mdbook
+
+  #     - name: Test ${{ matrix.language }} translation
+  #       run: msgfmt --statistics -o /dev/null po/${{ matrix.language }}.po
+
+  #     - name: Build book with ${{ matrix.language }} translation
+  #       run: mdbook build
+
+  #     - name: Upload ${{ matrix.language }} translation
+  #       uses: actions/upload-artifact@v3
+  #       with:
+  #         name: rust-design-patterns-${{ matrix.language }}
+  #         path: book/
+
+  #     - name: Test code snippets with ${{ matrix.language }} translation
+  #       run: mdbook test

.github/workflows/install-mdbook/action.yml

@@ -0,0 +1,29 @@
+name: Install mdbook and dependencies
+
+description: Install the mdbook with the dependencies we need.
+
+runs:
+  using: composite
+  steps:
+    - name: Read mdbook version from .env
+      id: mdbook-version
+      run: |
+        . ./.env
+        echo "::set-output name=MDBOOK_VERSION::${MDBOOK_VERSION}"
+      shell: bash
+
+    - name: Read mdbook-i8n-helpers version from .env
+      id: mdbook-i8n-helpers-version
+      run: |
+        . ./.env
+        echo "::set-output name=MDBOOK_I8N_HELPERS_VERSION::${MDBOOK_I8N_HELPERS_VERSION}"
+      shell: bash
+
+    # The --locked flag is important for reproducible builds.
+    - name: Install mdbook
+      run: cargo install mdbook --locked --version '${{ steps.mdbook-version.outputs.MDBOOK_VERSION }}'
+      shell: bash
+
+    - name: Install i18n-helpers
+      run: cargo install mdbook-i18n-helpers --locked --version '${{ steps.mdbook-i8n-helpers-version.outputs.MDBOOK_I8N_HELPERS_VERSION }}'
+      shell: bash

.github/workflows/lint.yml

@@ -0,0 +1,14 @@
+name: Lint Markdown
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+jobs:
+  style:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: dprint/[email protected]

.github/workflows/publish.yml

@@ -0,0 +1,67 @@
+name: Deploy mdBook sites to GH Pages
+
+on:
+  push:
+    branches: ["main"]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow one concurrent deployment
+concurrency:
+  group: "pages"
+  cancel-in-progress: true
+
+env:
+  CARGO_TERM_COLOR: always
+  # TODO: Update the language picker in index.hbs to link new languages.
+  # TODO: As long as https://github.com/google/mdbook-i18n-helpers/issues/12 is not implemented, yet.
+  # TODO: Activate when first translation is available
+  # These are the languages in addition to 'en', which is the main language
+  # LANGUAGES: xx
+
+jobs:
+  publish:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Setup Rust cache
+        uses: ./.github/workflows/setup-rust-cache
+
+      - name: Install mdbook
+        uses: ./.github/workflows/install-mdbook
+
+      - name: Build course in English
+        run: mdbook build -d book
+
+      # TODO: Activate when first translation is available
+      # - name: Build all translations
+      #   run: |
+      #     for po_lang in ${{ env.LANGUAGES }}; do
+      #         echo "::group::Building $po_lang translation"
+      #         MDBOOK_BOOK__LANGUAGE=$po_lang \
+      #         MDBOOK_OUTPUT__HTML__SITE_URL=/patterns/$po_lang/ \
+      #         mdbook build -d book/$po_lang
+      #         echo "::endgroup::"
+      #     done
+
+      - name: Setup Pages
+        id: pages
+        uses: actions/configure-pages@v3
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v1
+        with:
+          path: ./book
+
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v2

.github/workflows/setup-rust-cache/action.yml

@@ -0,0 +1,11 @@
+name: Setup Rust cache
+
+description: Configure the rust-cache workflow.
+
+runs:
+  using: composite
+  steps:
+    - name: Setup Rust cache
+      uses: Swatinem/rust-cache@v2
+      with:
+        prefix-key: v1

CONTRIBUTING.md

@@ -7,7 +7,7 @@ idioms and other explanations. It is a compilation of collective (sometimes
 implicit) knowledge as well as experiences that have emerged through
 collaborative work.
 
-The patterns described here are __not rules__, but should be taken as
+The patterns described here are **not rules**, but should be taken as
 guidelines for writing idiomatic code in Rust. We are collecting Rust patterns
 in this book so people can learn the tradeoffs between Rust idioms and use them
 properly in their own code.

book.toml

@@ -4,19 +4,33 @@ authors = ["the rust-unofficial authors"]
 description = "A catalogue of Rust design patterns, anti-patterns and idioms"
 language = "en"
 multilingual = false
-src = "."
+src = "src"
 
 [build]
 create-missing = false
+extra-watch-dirs = ["po", "third_party"]
+
+[preprocessor.gettext]
+after = ["links"]
 
 [rust]
 edition = "2018"
 
 [output.html]
+curly-quotes = true
 default-theme = "rust"
 site-url = "/patterns/"
 git-repository-url = "https://github.com/rust-unofficial/patterns"
 git-repository-icon = "fa-github"
 edit-url-template = "https://github.com/rust-unofficial/patterns/edit/main/{path}"
+additional-css = ["./language-picker.css"]
+additional-js = ["./third_party/mdbook/book.js"]
+
+[output.html.fold]
+enable = true
+level = 1
+
+[output.html.playground]
+editable = false
 
 # [output.linkcheck]  # enable the "mdbook-linkcheck" renderer, disabled due to gh-actions

dprint.json

@@ -0,0 +1,11 @@
+{
+  "lineWidth": 80,
+  "markdown": {},
+  "includes": [
+    "**/*.{md}"
+  ],
+  "excludes": [],
+  "plugins": [
+    "https://plugins.dprint.dev/markdown-0.15.2.wasm"
+  ]
+}

language-picker.css

@@ -0,0 +1,8 @@
+#language-list {
+  left: auto;
+  right: 10px;
+}
+
+#language-list a {
+  color: inherit;
+}