feat(mkdocs): WIP extensions for markdown

This commit is contained in:
Sebastian Qvarfordt
2020-06-23 17:51:48 +02:00
parent 1253f82057
commit cb6742c15e
4 changed files with 62 additions and 12 deletions
+2 -2
View File
@@ -15,8 +15,8 @@
FROM python:3.7.7-alpine3.12
RUN apk update && apk --no-cache add gcc musl-dev
RUN pip install mkdocs==1.1.2 mkdocs-material==5.3.2
RUN apk update && apk --no-cache add gcc musl-dev graphviz
RUN pip install --upgrade pip && pip install mkdocs==1.1.2 mkdocs-material==5.3.2 pymdown-extensions==7.1 markdown_inline_graphviz_extension==1.1 plantuml-markdown==3.2.2 markdown-katex==202006.1021
ADD ./techdocs-core /techdocs-core
RUN pip install --no-index /techdocs-core
@@ -21,15 +21,63 @@ from mkdocs.contrib.search import SearchPlugin
class TechDocsCore(BasePlugin):
def on_config(self, config):
# Theme
config['theme'] = Theme(name="material")
# Theme
config['theme'] = Theme(name="material")
# Plugins
del config['plugins']['techdocs-core']
# Plugins
del config['plugins']['techdocs-core']
search_plugin = SearchPlugin()
search_plugin.load_config({})
config['plugins']['search'] = search_plugin
search_plugin = SearchPlugin()
search_plugin.load_config({})
config['plugins']['search'] = search_plugin
return config
# Markdown Extensions
print(config)
config['markdown_extensions'].append('admonition')
config['markdown_extensions'].append('abbr')
config['markdown_extensions'].append('attr_list')
config['markdown_extensions'].append('def_list')
config['markdown_extensions'].append('codehilite')
config['mdx_configs']['codehilite'] = {
'linenums': True,
'guess_lang': False,
'pygments_style': 'friendly',
}
config['markdown_extensions'].append('toc')
config['mdx_configs']['toc'] = {
'permalink': True,
}
config['markdown_extensions'].append('footnotes')
config['markdown_extensions'].append('markdown.extensions.tables')
config['markdown_extensions'].append('markdown_inline_graphviz')
config['markdown_extensions'].append('plantuml_markdown')
config['markdown_extensions'].append('markdown_katex')
config['mdx_configs']['markdown_katex'] = {
'no_inline_svg': True,
'insert_fonts_css': True,
}
config['markdown_extensions'].append('pymdownx.betterem')
config['mdx_configs']['pymdownx.betterem'] = {
'smart_enable': 'all',
}
config['markdown_extensions'].append('pymdownx.caret')
config['markdown_extensions'].append('pymdownx.critic')
config['markdown_extensions'].append('pymdownx.details')
config['markdown_extensions'].append('pymdownx.emoji')
config['mdx_configs']['pymdownx.emoji'] = {
'emoji_generator': '!!python/name:pymdownx.emoji.to_svg',
}
config['markdown_extensions'].append('pymdownx.inlinehilite')
config['markdown_extensions'].append('pymdownx.magiclink')
config['markdown_extensions'].append('pymdownx.mark')
config['markdown_extensions'].append('pymdownx.smartsymbols')
config['markdown_extensions'].append('pymdownx.superfences')
config['markdown_extensions'].append('pymdownx.tasklist')
config['mdx_configs']['pymdownx.tasklist'] = {
'custom_checkbox': True,
}
config['markdown_extensions'].append('pymdownx.tilde')
print(config)
return config
@@ -1 +1,4 @@
## hello mock docs
!!! test
Testing somethin
+1 -2
View File
@@ -4,5 +4,4 @@ nav:
- Home: index.md
plugins:
- techdocs-core
- techdocs-core