From cef46e571e9b5d1e12bd1da72c0da8050df8a82a Mon Sep 17 00:00:00 2001 From: Jim Galasyn Date: Mon, 18 Nov 2019 20:06:42 -0800 Subject: [PATCH] docs: add section on installing plugins to README.md (DOCS-2970) (#3903) --- docs-md/README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/docs-md/README.md b/docs-md/README.md index 7236490a39f8..d27bdcb2c42e 100644 --- a/docs-md/README.md +++ b/docs-md/README.md @@ -46,6 +46,27 @@ pip install mkdocs For more information, see [Installation](https://www.mkdocs.org/#installation). +Install MkDocs plugins and extensions +------------------------------------- + +The ksqlDB documentation build uses these plugins and extensions: + +- **mdx_gh_links:** shorthand links to GitHub +- **mkdocs-macros-plugin:** variables and macros +- **mkdocs-git-revision-date-plugin:** page last updated in GitHub +- **pymdown-extensions:** adds features to the standard Python Markdown library +- **mkdocs-material:** docs site theme + +Install the plugins and extensions by using the `pip` installer: + +```bash +pip install mdx_gh_links +pip install mkdocs-macros-plugin +pip install mkdocs-git-revision-date-plugin +pip install pymdown-extensions +pip install mkdocs-material +``` + Build the docs --------------