Skip to content

Commit

Permalink
docs: add section on installing plugins to README.md (DOCS-2970) (#3903)
Browse files Browse the repository at this point in the history
  • Loading branch information
JimGalasyn authored Nov 19, 2019
1 parent a201a93 commit cef46e5
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions docs-md/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
--------------

Expand Down

0 comments on commit cef46e5

Please sign in to comment.