From afedcf719e3bf778c0b57de131129d78e67f5e36 Mon Sep 17 00:00:00 2001 From: Vikash Kothary Date: Thu, 30 Jul 2020 20:15:49 +0100 Subject: [PATCH] Generate mkdocs markdown documentation --- docs/mkdocs.yml | 9 +++++++++ docs/src/index.md | 19 +++++++++++++++++++ 2 files changed, 28 insertions(+) create mode 100644 docs/mkdocs.yml create mode 100644 docs/src/index.md 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.