You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Generating our own numbering automatically (numbers will not be in source file):
Pros: Can be consistency easily, less work, less error; Removing and adding new heading is easy
Cons: Not transparent. A human editor who like to make a reference to a section in a chapter needs to generate that chapter first to get an HTML anchor name. Depends on when in the workflow the anchor/id is generated, the anchor validation during the MkDocs build may not work.
Adding anchor manually (numbers will be source file):
Pro: Transparent. A human editor can just look at the source file and get immediately the HTML anchor name
Cons: Tedious and prone to error; Removing and adding new headings mean re-numbering work
This ID is supported by GitHub and other Markdown authoring tools. Some authoring tools can offer a list of heading IDs to choose from when the author type # in the link syntax:
MkDocs generates the ID from the heading name. As few document has multiple headings with the same name (like "Purpose", "Guideline"), the MkDocs generation may not work for these documents if there's no numbering. But there can be a workaround by renaming those headings to be unique.
If numbering is to be inserted later and not presented in the source file, the authoring tool will not know the ID a5-differences-from-v22-and-v21, as the ID that can be derived from the source from the authoring tool perspective is differences-from-v22-and-v21 (without a5).
There should be no numbering on chapter and section headers.
It is automatically added while creating the PDF.
The text was updated successfully, but these errors were encountered: