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 +```