diff --git a/docs/features/techdocs/getting-started.md b/docs/features/techdocs/getting-started.md index 288ddb74ae..cbbbc1e6cd 100644 --- a/docs/features/techdocs/getting-started.md +++ b/docs/features/techdocs/getting-started.md @@ -92,14 +92,21 @@ techdocs: Setting `generators.techdocs` to `local` means you will have to make sure your environment is compatible with techdocs. -You will have to install the `mkdocs-techdocs-core` and `mkdocs` package from +You will have to install the `mkdocs` and `mkdocs-techdocs-core` package from pip, as well as `graphviz` and `plantuml` from your OS package manager (e.g. apt). See our [Dockerfile](https://github.com/spotify/backstage/blob/master/packages/techdocs-container/Dockerfile) for the latest requirements. You should be trying to match your Dockerfile with this one. -It is worth mentioning that we recommend Python version 3.7 or higher. +Note: We recommend Python version 3.7 or higher. + +Caveat: Please install the `mkdocs-techdocs-core` package after all other Python +packages. The order is important to make sure we get correct version of some of +the dependencies. For example, we want `Markdown` version to be +[3.2.2](https://github.com/spotify/backstage/blob/f9f70c225548017b6a14daea75b00fbd399c11eb/packages/techdocs-container/techdocs-core/requirements.txt#L11). +You can also explicitly install `Markdown==3.2.2` after installing all other +Python packages. ## Run Backstage locally