diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml new file mode 100644 index 0000000..3737456 --- /dev/null +++ b/docs/mkdocs.yml @@ -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 \ No newline at end of file diff --git a/docs/src/index.md b/docs/src/index.md new file mode 100644 index 0000000..03a9c49 --- /dev/null +++ b/docs/src/index.md @@ -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.