paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 29 Packages Projects Releases Wiki Activity

Run prettier on doc files

Browse Source
This commit is contained in:
Himanshu Mishra
2020-10-01 08:54:14 +02:00
committed by GitHub
parent d0bfdf8ee5
commit 5dff92ca11
1 changed files with 5 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/features/techdocs/FAQ.md
+5 -4
View File
@@ -18,7 +18,8 @@ This page answers frequently asked questions about [TechDocs](README.md).
TechDocs is using [MkDocs](https://www.mkdocs.org/) to build project
documentation 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](https://github.com/squidfunk/mkdocs-material).
is using the MkDocs
[Material Theme](https://github.com/squidfunk/mkdocs-material).
#### What is the mkdocs-techdocs-core plugin?
@@ -32,6 +33,6 @@ well as a selection of Python Markdown extensions that TechDocs supports.
#### Does TechDocs support file formats other than Markdown (e.g. RST, AsciiDoc) ?
Not right now. We are currently using MkDocs to generate the documentation from
source, so the files have to be in Markdown format. However, in the future we want to
support other static site generators which will make it possible to use other
file formats.
source, so the files have to be in Markdown format. However, in the future we
want to support other static site generators which will make it possible to use
otherfile formats.