Merge pull request #1430 from hooloovooo/techdocs_md_extensions

Techdocs md extensions

plugins/techdocs/mkdocs/container/Dockerfile

@@ -15,7 +15,7 @@
 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 mkdocs-monorepo-plugin==0.4.5
+RUN pip install --upgrade pip && pip install mkdocs==1.1.2 mkdocs-material==5.3.2 mkdocs-monorepo-plugin==0.4.5 pymdown-extensions==7.1
 
 ADD ./techdocs-core /techdocs-core
 RUN pip install --no-index /techdocs-core

plugins/techdocs/mkdocs/container/techdocs-core/src/core.py

@@ -43,4 +43,43 @@ class TechDocsCore(BasePlugin):
         search_plugin.load_config({})
         config["plugins"]["search"] = search_plugin
 
+        # Markdown Extensions
+        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('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')
+
         return config

plugins/techdocs/mkdocs/mock-docs/docs/index.md

@@ -1 +1,32 @@
 ## hello mock docs
+
+!!! test
+Testing somethin
+
+Some text about MOCDOC
+
+\*[MOCDOC]: Mock Documentation
+
+This is a paragraph.
+{: #test_id .test_class }
+
+Apple
+: Pomaceous fruit of plants of the genus Malus in
+the family Rosaceae.
+
+```javascript
+import { test } from 'something';
+
+const addThingToThing = (a, b) a + b;
+```
+
+- [abc](#abc)
+- [xyz](#xyz)
+
+## abc
+
+This is a b c.
+
+## xyz
+
+This is x y z.

plugins/techdocs/mkdocs/mock-docs/mkdocs.yml

@@ -6,4 +6,3 @@ nav:
 
 plugins:
   - techdocs-core
-