Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 15 additions & 6 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -57,8 +57,15 @@ jobs:
mkdocs build --strict -f "$RUNNER_TEMP/smoke/mkdocs.yml"

docs:
name: Docs site (full plugin stack)
name: Docs site (full plugin stack, ${{ matrix.tool }})
runs-on: ubuntu-latest
strategy:
fail-fast: false
matrix:
# ProperDocs continues MkDocs 1.x and reads the same config and theme
# entry point. The docs plugins already install it, so building with
# both costs no extra dependencies. See #107.
tool: [mkdocs, properdocs]
steps:
- uses: actions/checkout@v4
with:
Expand All @@ -74,13 +81,15 @@ jobs:
- run: npm ci
# Every plugin that needs theme support is enabled in mkdocs.yml, so this
# build is where a regression in that support surfaces.
- run: mkdocs build --strict
- run: ${{ matrix.tool }} build --strict
# The examples cover plugins that cannot share a config with the main
# site. They build into site/, so they have to run after it — that build
# cleans the directory.
- run: mkdocs build --strict -f examples/rss/mkdocs.yml
- run: mkdocs build --strict -f examples/gen-files/mkdocs.yml
- run: mkdocs build --strict -f examples/diagrams/mkdocs.yml
- run: ${{ matrix.tool }} build --strict -f examples/rss/mkdocs.yml
- run: ${{ matrix.tool }} build --strict -f examples/gen-files/mkdocs.yml
- run: ${{ matrix.tool }} build --strict -f examples/diagrams/mkdocs.yml
# Workbox precaches the generated site and the theme registers the
# resulting service worker when `theme.offline` is enabled.
# resulting service worker when `theme.offline` is enabled. The script
# runs mkdocs itself, so it only needs to run once.
- run: npm run build:offline
if: matrix.tool == 'mkdocs'
2 changes: 2 additions & 0 deletions docs/guide/installation.es.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,5 @@ theme:
```

Esa es toda la configuración: cada opción de abajo tiene un valor por defecto que funciona.

El tema funciona igual con [ProperDocs](https://properdocs.org/), la continuación de MkDocs 1.x. Instálalo con `pip install properdocs` y compila con `properdocs build`. Lee el mismo `mkdocs.yml`.
2 changes: 2 additions & 0 deletions docs/guide/installation.fr.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,5 @@ theme:
```

C'est toute la configuration : chaque option ci-dessous a une valeur par défaut qui fonctionne.

Le thème fonctionne de la même façon avec [ProperDocs](https://properdocs.org/), la continuation de MkDocs 1.x. Installez-le avec `pip install properdocs` et construisez avec `properdocs build`. Il lit le même `mkdocs.yml`.
2 changes: 2 additions & 0 deletions docs/guide/installation.hi.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,5 @@ theme:
```

बस इतना ही सेटअप है — नीचे दिए हर विकल्प का एक कारगर डिफ़ॉल्ट मान है।

यह थीम [ProperDocs](https://properdocs.org/) के साथ भी वैसे ही काम करती है, जो MkDocs 1.x को आगे जारी रखता है। इसे `pip install properdocs` से इंस्टॉल करें और `properdocs build` से बिल्ड करें। यह वही `mkdocs.yml` पढ़ता है।
2 changes: 2 additions & 0 deletions docs/guide/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,5 @@ theme:
```

That is the whole setup. Every option below has a working default.

The theme works the same with [ProperDocs](https://properdocs.org/), the continuation of MkDocs 1.x. Install it with `pip install properdocs` and build with `properdocs build`. It reads the same `mkdocs.yml`.
2 changes: 2 additions & 0 deletions docs/guide/installation.pt.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,5 @@ theme:
```

É toda a configuração — cada opção abaixo tem um valor padrão que funciona.

O tema funciona do mesmo jeito com o [ProperDocs](https://properdocs.org/), a continuação do MkDocs 1.x. Instale com `pip install properdocs` e gere o site com `properdocs build`. Ele lê o mesmo `mkdocs.yml`.
2 changes: 2 additions & 0 deletions docs/guide/installation.ru.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,5 @@ theme:
```

Это вся настройка — у каждой опции ниже есть рабочее значение по умолчанию.

Тема так же работает с [ProperDocs](https://properdocs.org/) — продолжением MkDocs 1.x. Установите его через `pip install properdocs` и собирайте сайт командой `properdocs build`. Он читает тот же `mkdocs.yml`.
2 changes: 2 additions & 0 deletions docs/guide/installation.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,5 @@ theme:
```

配置到此为止 —— 下面的每个选项都有可用的默认值。

本主题同样适用于 [ProperDocs](https://properdocs.org/),即 MkDocs 1.x 的延续版本。用 `pip install properdocs` 安装,再用 `properdocs build` 构建。它读取同一个 `mkdocs.yml`。
Loading