diff options
Diffstat (limited to 'docs/_klipper3d')
| -rw-r--r-- | docs/_klipper3d/mkdocs_hooks.py | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/docs/_klipper3d/mkdocs_hooks.py b/docs/_klipper3d/mkdocs_hooks.py index f8e88839..b0e78f81 100644 --- a/docs/_klipper3d/mkdocs_hooks.py +++ b/docs/_klipper3d/mkdocs_hooks.py @@ -2,6 +2,16 @@ import re import logging +# This script translates some github specific markdown formatting to +# improve rendering with mkdocs. The goal is for pages to render +# similarly on both github and the web site. It has three main tasks: +# 1. Convert links outside of the docs directory (any reference +# starting with "../") to an absolute link to the raw file on +# github. +# 2. Convert a trailing backslash on a text line to a "<br>". +# 3. Remove leading spaces from top-level lists so that those lists +# are rendered correctly. + logger = logging.getLogger('mkdocs.mkdocs_hooks.transform') def transform(markdown: str, page, config, files): |