https://github.com/kjuly/mkdocs-page-builder

Github Action to build MkDocs source files as static pages, supporting multiple config files.
https://github.com/kjuly/mkdocs-page-builder

build github-action github-pages i18n mkdocs

Last synced: about 2 months ago
JSON representation

Github Action to build MkDocs source files as static pages, supporting multiple config files.

• Host: GitHub
• URL: https://github.com/kjuly/mkdocs-page-builder
• Owner: Kjuly
• License: mit
• Created: 2024-05-06T02:58:38.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2024-07-02T10:23:04.000Z (7 months ago)
• Last Synced: 2024-12-18T20:14:01.107Z (about 2 months ago)
• Topics: build, github-action, github-pages, i18n, mkdocs
• Language: Shell
• Homepage:
• Size: 10.7 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# mkdocs-page-builder

Github Action to build MkDocs source files as static pages, supporting multiple config files.

## Usage

The `mkdocs.yml` in the root directory will be used by default.

```yaml

jobs:

  build:

    name: Build MkDocs Pages

    runs-on: ubuntu-latest

    steps:

      - name: Checkout

        uses: actions/checkout@v4

      - name: Build Pages

        uses: Kjuly/mkdocs-page-builder@main

        with:

          requirements_file: requirements.txt

```

If you have multiple config files to handle multi-languages, you can provide `config_files`:

```yaml

uses: Kjuly/mkdocs-page-builder@main

with:

  requirements_file: requirements.txt

  config_files: |-

    config/en/mkdocs.yml

    config/zh-Hans/mkdocs.yml

```

---

The build page will be stored in `${{ github.workspace }}/build`.

For output usage, please refer to [MkDocs Page Publisher][mkdocs-page-publisher], which will publish to Github Pages.

  [mkdocs-page-publisher]: https://github.com/Kjuly/mkdocs-page-publisher