https://github.com/tiryoh/actions-mkdocs

⚙️ GitHub Actions for MkDocs
https://github.com/tiryoh/actions-mkdocs

actions github-pages mkdocs

Last synced: about 16 hours ago
JSON representation

⚙️ GitHub Actions for MkDocs

• Host: GitHub
• URL: https://github.com/tiryoh/actions-mkdocs
• Owner: Tiryoh
• License: mit
• Created: 2020-12-13T15:31:53.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2025-06-02T22:45:25.000Z (24 days ago)
• Last Synced: 2025-06-15T16:11:18.094Z (11 days ago)
• Topics: actions, github-pages, mkdocs
• Language: Shell
• Homepage:
• Size: 445 KB
• Stars: 10
• Watchers: 2
• Forks: 8
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# actions-mkdocs

[![Test](https://github.com/Tiryoh/actions-mkdocs/actions/workflows/test.yaml/badge.svg?branch=main)](https://github.com/Tiryoh/actions-mkdocs/actions/workflows/test.yaml?query=branch%3Amain)

GitHub Actions for MkDocs

## Inputs

### `mkdocs_version`

Default: `'latest'`

The version of pip, MkDocs. 

### `requirements`

Default: `requirements.txt`

The path to `requirements.txt`

### `configfile`

Default: `mkdocs.yml`

The path to `mkdocs.yml`

## Example usage

```yaml

name: Deploy

on:

  push:

    branches:

      - main

jobs:

  build:

    name: Deploy docs to GitHub Pages

    runs-on: ubuntu-latest

    steps:

      - name: Checkout 

        uses: actions/checkout@v2

      - name: Build

        uses: Tiryoh/actions-mkdocs@v0

        with:

          mkdocs_version: 'latest' # option

          #mkdocs_version: '1.1' # option

          requirements: 'requirements.txt' # option

          configfile: 'mkdocs.yml' # option

      - name: Deploy

        uses: peaceiris/actions-gh-pages@v3

        with:

          github_token: ${{ secrets.GITHUB_TOKEN }}

          publish_dir: ./site

```

## Related projects

* [Tiryoh/docker-mkdocs-builder](https://github.com/Tiryoh/docker-mkdocs-builder)

    * Dockerfile that just builds the MkDocs document

* [squidfunk/mkdocs-material](https://github.com/squidfunk/mkdocs-material)

    * A Material Design theme for MkDocs, this project includes build & deploy Dockerfile

* [peaceiris/actions-gh-pages](https://github.com/peaceiris/actions-gh-pages)

    * GitHub Actions for GitHub Pages rocket Deploy static files and publish your site easily. Static-Site-Generators-friendly.

## License

Copyright (c) 2020-2021 Daisuke Sato

This repository is licensed under the MIT License, see [LICENSE](./LICENSE).

Unless attributed otherwise, everything in this repository is licensed under the MIT license.

### Acknowledgements

This repository includes third-party libraries and software. See [THIRD-PARTY-NOTICES.md](./THIRD-PARTY-NOTICES.md).