feat: Add MkDocs site and deployment workflow
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.
This commit is contained in:
parent
86585a6907
commit
74de15af8a
3 changed files with 19 additions and 0 deletions
15
.github/workflows/mkdocs.yml
vendored
Normal file
15
.github/workflows/mkdocs.yml
vendored
Normal file
|
|
@ -0,0 +1,15 @@
|
||||||
|
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
|
||||||
4
mkdocs.yml
Normal file
4
mkdocs.yml
Normal file
|
|
@ -0,0 +1,4 @@
|
||||||
|
site_name: Borg Data Collector
|
||||||
|
repo_url: https://github.com/Snider/Borg
|
||||||
|
theme:
|
||||||
|
name: material
|
||||||
Loading…
Add table
Reference in a new issue