add MkDocs

Signed-off-by: Michel-FK <michel.stempin@funkey-project.com>
This commit is contained in:
Michel-FK 2020-12-03 19:03:11 +01:00
parent 0beb3555c6
commit 07c5893646
5 changed files with 39 additions and 0 deletions

15
.github/workflows/ci.yml vendored Normal file
View File

@ -0,0 +1,15 @@
name: ci
on:
push:
branches:
- source
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 --remote-branch master

BIN
docs/assets/favicon.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 54 KiB

BIN
docs/assets/images/logo.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 20 KiB

17
docs/index.md Normal file
View File

@ -0,0 +1,17 @@
# Welcome to MkDocs
For full documentation visit [mkdocs.org](https://www.mkdocs.org).
## Commands
* `mkdocs new [dir-name]` - Create a new project.
* `mkdocs serve` - Start the live-reloading docs server.
* `mkdocs build` - Build the documentation site.
* `mkdocs -h` - Print help message and exit.
## Project layout
mkdocs.yml # The configuration file.
docs/
index.md # The documentation homepage.
... # Other markdown pages, images and other files.

7
mkdocs.yml Normal file
View File

@ -0,0 +1,7 @@
site_name: FunKey Project Documentation
theme:
name: material
logo: assets/images/logo.png
favicon: assets/favicon.png
palette:
primary: deep purple