Merge pull request #1698 from spotify/emmai/techdocs-faq

TechDocs: Update FAQ
This commit is contained in:
Emma Indal
2020-07-21 09:46:42 +02:00
committed by GitHub
2 changed files with 34 additions and 2 deletions
+29 -1
View File
@@ -1 +1,29 @@
# FAQ
# TechDocs FAQ
This page answer frequently asked questions about [TechDocs].
#### Technology
- [What static site generator is TechDocs using?](./#what-static-site-generator-is-techdocs-using)
- [What is the mkdocs-techdocs-core plugin?](./#what-is-the-mkdocs-techdocs-core-plugin)
## What static site generator is TechDocs using?
TechDocs is using [MkDocs](https://www.mkdocs.org/) to build project
doucmentation under the hood. Documentation built with the
[techdocs-container](https://github.com/spotify/backstage/blob/master/packages/techdocs-container/README.md)
is using the MkDocs Material Theme.
## What is the mkdocs-techdocs-core plugin?
The
[mkdocs-techdocs-core](https://github.com/spotify/backstage/blob/master/packages/techdocs-container/techdocs-core/README.md)
package is a MkDocs Plugin that works like a wrapper around multiple MkDocs
plugins (e.g.
[MkDocs Monorepo Plugin](https://github.com/spotify/mkdocs-monorepo-plugin)) as
well as a selection of Python Markdown extensions that TechDocs supports.
_Add a question that you think others might be interested in? Edit the file
[here](https://github.com/spotify/backstage/edit/master/docs/features/techdocs/FAQ.md)._
[techdocs]: 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`.