minio/docs
1
0
Fork 0
mirror of https://github.com/minio/docs.git synced 2025-07-28 19:42:10 +03:00
Code Activity

Attempting to enable github rendering of markdown (#623)

Browse Source 
# Summary

The default Markdown parser MyST provides doesn't seem to like the way
we've designed our SDK Markdown docs.

This change *should* enable github-strict parsing. It also adds
auto-headers to all H1s, which might resolve some of the TOC issues.

This gives us some breathing room to fixup the SDKs where we can still
allow for the files to look good in GitHub, but know they will render
properly on our Sphinx-built docs.
This commit is contained in:
Ravind Kumar
2022-11-01 12:02:29 -04:00
committed by GitHub
parent 64ca9697cf
commit 581de9f9ea
2 changed files with 7 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
requirements.txt
View File

@ -7,4 +7,6 @@ Sphinx-Substitution-Extensions == 2020.9.30.0
sphinx-sitemap == 2.2.0 sphinx-sitemap == 2.2.0
sphinx-togglebutton === 0.3.2 sphinx-togglebutton === 0.3.2
sphinxcontrib-images === 0.9.4 sphinxcontrib-images === 0.9.4
myst-parser === 0.18.0 myst-parser === 0.18.0
linkify === 1.4
linkify-it-py === 2.0.0

4
source/default-conf.py
View File

@ -218,6 +218,10 @@ else:
exclude_patterns.extend(excludes) exclude_patterns.extend(excludes)
# MyST Parser Customization
myst_gfm_only = True
myst_heading_anchors = 2
# Copy-Button Customization # Copy-Button Customization
copybutton_selector = "div.copyable pre" copybutton_selector = "div.copyable pre"