This PR add a configuration category_heading. It determines how categories headings are generated.
If simple, headings will be ## Category, and IDs are set by GitHub. (Same as current version)
If robust, headings will be <h2 id='category-id'>Category</h2>.
Resolves #65
TOC relies on these IDs. If all of categories' names are ASCII, simple is OK. Otherwise, GitHub may slugify the title into something unexpected (e.g. 🌎Globe → Globe but ⚒️Hammer → %EF%B8%8FHammer), and links in TOC will be broken.
I've also introduced an (internal & unused) BREAKING change: title_md_prefix: str = "##" → heading_level: int = 2. As you can see, title_md_prefix can't describe <h2>.
What kind of change does this PR introduce?
Description:
This PR add a configuration
category_heading. It determines how categories headings are generated.simple, headings will be## Category, and IDs are set by GitHub. (Same as current version)robust, headings will be<h2 id='category-id'>Category</h2>.Resolves #65
TOC relies on these IDs. If all of categories' names are ASCII,
simpleis OK. Otherwise, GitHub may slugify the title into something unexpected (e.g.🌎Globe→Globebut⚒️Hammer→%EF%B8%8FHammer), and links in TOC will be broken.I've also introduced an (internal & unused) BREAKING change:
title_md_prefix: str = "##"→heading_level: int = 2. As you can see,title_md_prefixcan't describe<h2>.Checklist: