74de15af8a
This commit introduces a documentation website built with MkDocs and the Material theme. Key changes: - Added a `mkdocs.yml` configuration file. - Renamed `docs/README.md` to `docs/index.md` to serve as the site's homepage. - Created a GitHub Actions workflow (`.github/workflows/mkdocs.yml`) to automatically build and deploy the site to GitHub Pages on pushes to the `main` branch.
15 lines
301 B
YAML
15 lines
301 B
YAML
name: mkdocs
|
|
on:
|
|
push:
|
|
branches:
|
|
- main
|
|
jobs:
|
|
deploy:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@v2
|
|
- uses: actions/setup-python@v2
|
|
with:
|
|
python-version: 3.x
|
|
- run: pip install mkdocs-material
|
|
- run: mkdocs gh-deploy --force
|