Showing posts with label mkdocs. Show all posts
Showing posts with label mkdocs. Show all posts

2024-07-18

Note on migrating MediaWiki articles to static MarkDown with mkdocs-material

Anchors generated from MediaWiki section headers get transformed by the "toc" MarkDown extension. When that happens, there is some transformation of the section header:

  • the generated anchor is all lower-case
  • spaces are transformed into the “separator” character, which is “-” (hyphen) by default
    • that can be customized in mkdocs.yml
  • “-” (hyphen) is retained
  • many punctuation marks are dropped: “.” (period), “(” and “)” (parentheses), “,” (comma), and probably others as well