Generate mkdocs markdown documentation

This commit is contained in:
Vikash Kothary 2020-07-30 20:15:49 +01:00
parent cfeb466e13
commit afedcf719e
2 changed files with 28 additions and 0 deletions

9
docs/mkdocs.yml Normal file
View File

@ -0,0 +1,9 @@
strict: true
theme: readthedocs
site_name: Anki Sync Server
site_description: Self-hosted Anki Sync Server.
site_author: Anki Community
site_url: https://ankicommunity.github.io/anki-sync-server
repo_url: https://github.com/ankicommunity/anki-sync-server
docs_dir: src
site_dir: build

19
docs/src/index.md Normal file
View File

@ -0,0 +1,19 @@
# Welcome to MkDocs
Welcome to the anki-sync-server wiki!
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.
src/
index.md # The documentation homepage.
... # Other markdown pages, images and other files.