added mkdocs

This commit is contained in:
alterNERDtive 2021-01-20 12:29:15 +01:00
parent abd3b07e60
commit a3bd10f4ae
3 changed files with 25 additions and 0 deletions

1
.gitignore vendored
View file

@ -356,3 +356,4 @@ MigrationBackup/
/build
/alterNERDtive-VoiceAttack-profiles.vax
/Makefile
/site

17
docs/index.md Normal file
View file

@ -0,0 +1,17 @@
# Welcome to MkDocs
For full documentation visit [mkdocs.org](https://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 help` - Print this help message.
## 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 @@
edit_uri: ""
site_name: My Docs
theme: readthedocs
plugins:
- search
- roamlinks