Initial commit

Author: squidfunk

.gitignore

@@ -0,0 +1,29 @@
+# Copyright (c) 2020 Martin Donath <[email protected]>
+
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to
+# deal in the Software without restriction, including without limitation the
+# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+# sell copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+# IN THE SOFTWARE.
+
+# macOS internals
+.DS_Store
+
+# Python-related
+__pycache__
+venv
+
+# Files generated by build
+/site

README.md

@@ -0,0 +1,46 @@
+> This is an example of the new [versioning][1] feature of
+[Material for MkDocs][2].
+
+  [1]: https://squidfunk.github.io/mkdocs-material/setup/setting-up-versioning/
+  [2]: https://squidfunk.github.io/mkdocs-material/
+
+## How to set up versioning
+
+First, install [Material for MkDocs Insiders][3] and [mike][4]:
+
+```
+pip install git+https://${GH_TOKEN}@github.com/squidfunk/mkdocs-material-insiders.git
+pip install mike
+```
+
+  [3]: https://squidfunk.github.io/mkdocs-material/insiders/
+  [4]: https://github.com/jimporter/mike
+
+Next, set up your documentation project:
+
+```
+mkdocs new .
+```
+
+Update `mkdocs.yml`:
+
+``` yaml
+site_name: My Docs
+theme:
+  name: material
+extra:
+  version:
+    method: mike
+```
+
+Set the default version to `latest`
+
+```
+mike set-default latest
+```
+
+Make a change to `docs/index.md`, and publish the first version:
+
+```
+mike --push --update-aliases 0.1 latest
+```

docs/index.md

@@ -0,0 +1,17 @@
+# Welcome to MkDocs 0.1
+
+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.

mkdocs.yml

@@ -0,0 +1,6 @@
+site_name: My Docs
+theme:
+  name: material
+extra:
+  version:
+    method: mike