From 062b214e0669d987e6e8b099cf8322b0a0a428b4 Mon Sep 17 00:00:00 2001 From: Emma Indal Date: Tue, 23 Jun 2020 11:29:05 +0200 Subject: [PATCH] docs(mkdocs): add readme --- plugins/techdocs/mkdocs/README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 plugins/techdocs/mkdocs/README.md diff --git a/plugins/techdocs/mkdocs/README.md b/plugins/techdocs/mkdocs/README.md new file mode 100644 index 0000000000..5126548f54 --- /dev/null +++ b/plugins/techdocs/mkdocs/README.md @@ -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 +```