diff --git a/plugins/techdocs/README.md b/plugins/techdocs/README.md index f25ffda3b2..10ddcf9411 100644 --- a/plugins/techdocs/README.md +++ b/plugins/techdocs/README.md @@ -4,6 +4,10 @@ Welcome to the TechDocs plugin - Spotify's docs-like-code approach built directl **WIP: This plugin 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).** +## Sections + +- [MkDocs](./mkdocs/README.md) + ## Getting started Your plugin has been added to the example app in this repository, meaning you'll be able to access it by running `yarn start` in the root directory, and then navigating to [/techdocs](http://localhost:3000/techdocs). 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 +``` diff --git a/plugins/techdocs/mkdocs/container/Dockerfile b/plugins/techdocs/mkdocs/container/Dockerfile new file mode 100644 index 0000000000..89ca705095 --- /dev/null +++ b/plugins/techdocs/mkdocs/container/Dockerfile @@ -0,0 +1,7 @@ +FROM python:3.7.7-alpine3.12 + +RUN apk update && apk --no-cache add gcc musl-dev +RUN pip install mkdocs==1.1.2 mkdocs-material==5.3.2 + +ENTRYPOINT [ "mkdocs" ] + diff --git a/plugins/techdocs/mkdocs/mock-docs/docs/index.md b/plugins/techdocs/mkdocs/mock-docs/docs/index.md new file mode 100644 index 0000000000..bc437e6180 --- /dev/null +++ b/plugins/techdocs/mkdocs/mock-docs/docs/index.md @@ -0,0 +1 @@ +## hello mock docs diff --git a/plugins/techdocs/mkdocs/mock-docs/mkdocs.yml b/plugins/techdocs/mkdocs/mock-docs/mkdocs.yml new file mode 100644 index 0000000000..c8370ae3ac --- /dev/null +++ b/plugins/techdocs/mkdocs/mock-docs/mkdocs.yml @@ -0,0 +1,4 @@ +site_name: 'mock-docs' + +nav: + - Home: index.md