docs: Add detailed documentation for HeadingPlugin and TOCPlugin #247
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
Add comprehensive documentation for the HeadingPlugin and TOCPlugin, detailing their interaction, configuration options, and usage examples. Documentation: - Document the interaction between the HeadingPlugin and TOCPlugin, including rendering order dependencies and the requirement for defined anchors in headings. - Provide examples of using grid layouts to position the table of contents above the content despite rendering order constraints. - Document configuration options for both heading and table of contents plugins, including usage examples for common scenarios. Resolves #229
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Resolves #229
Add comprehensive documentation for the HeadingPlugin and TOCPlugin, detailing their interaction, configuration options, and usage examples.
Documentation:
This PR was automatically generated.
If you want to make changes to this PR: