Allow use category id as heading's id #66
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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,
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>
.Checklist: