From 04114524ca4eda21c62def3ae561d97da4a5f261 Mon Sep 17 00:00:00 2001 From: Emma Indal Date: Tue, 21 Jul 2020 08:34:37 +0200 Subject: [PATCH] fix(techdocs-core): update installation instructions --- packages/techdocs-container/techdocs-core/README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/packages/techdocs-container/techdocs-core/README.md b/packages/techdocs-container/techdocs-core/README.md index 12b3acb1e2..9608780bd2 100644 --- a/packages/techdocs-container/techdocs-core/README.md +++ b/packages/techdocs-container/techdocs-core/README.md @@ -2,9 +2,13 @@ This is the base [Mkdocs](https://mkdocs.org) plugin used when using Mkdocs with Spotify's TechDocs. It is written in Python and packages all of our Mkdocs defaults, such as theming, plugins, etc in a single plugin. +[Python Package](https://pypi.org/project/mkdocs-techdocs-core/) + ## Usage -**Installation instructions TBD.** We haven't published it to a Python registry yet. +```bash +$ pip install mkdocs-techdocs-core +``` Once you have installed the `mkdocs-techdocs-core` plugin, you'll need to add it to your `mkdocs.yml`.