docs(mkdocs): add readme

2020-06-23 11:29:05 +02:00
parent f7771e0fd4
commit 062b214e06
1 changed files with 13 additions and 0 deletions
@@ -0,0 +1,13 @@
+# MkDocs
+
+Welcome to MkDocs. This is the TechDocs implementation of MkDocs.
+
+**WIP: This is a work in progress. It is not ready for use yet. Follow our progress on [the Backstage Discord](https://discord.gg/MUpMjP2) under #docs-like-code or on [our GitHub Milestone](https://github.com/spotify/backstage/milestone/15).**
+
+## Getting started
+
+```
+  docker build ./container -t mkdocs-container
+
+  docker run -w /content -v $(pwd)/mock-docs:/content -p 8000:8000 -it mkdocs-container serve -a 0.0.0.0:8000 --theme material
+```