-
Notifications
You must be signed in to change notification settings - Fork 22
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: Add documentation for HeadingPlugin and TOCPlugin
Add comprehensive documentation for the HeadingPlugin and TOCPlugin, including configuration details, usage examples, and best practices for content organization. Documentation: - Add new documentation for the HeadingPlugin, detailing configuration options, anchor settings, and usage examples. - Introduce documentation for the TOCPlugin, explaining its dependency on heading anchors and the required rendering order. - Update the index to include the new documentation pages for HeadingPlugin and TOCPlugin. Resolves #229
- Loading branch information
1 parent
1d6a629
commit b6d3b69
Showing
3 changed files
with
127 additions
and
0 deletions.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -83,6 +83,8 @@ Contents | |
custom_components | ||
grid | ||
components | ||
plugins/heading | ||
plugins/toc | ||
how-to/index | ||
reference | ||
|
||
|
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,60 @@ | ||
######### | ||
Heading | ||
######### | ||
|
||
The Heading plugin allows you to add headings (h1-h6) to your content with optional styling and anchors for navigation. | ||
|
||
************* | ||
Configuration | ||
************* | ||
|
||
- **Heading Level**: Choose h1-h6 for the heading tag | ||
- **Heading Text**: The text content of the heading | ||
- **Heading ID**: Optional anchor ID for TOC linking | ||
- **Heading Alignment**: Text alignment (left, center, right) | ||
- **Heading Context**: Optional Bootstrap contextual class for styling | ||
|
||
Example | ||
======= | ||
|
||
Basic heading:: | ||
|
||
<h2 id="my-section">My Section Title</h2> | ||
|
||
To create a heading that will appear in a table of contents: | ||
|
||
1. Add a Heading plugin | ||
2. Set the heading level (e.g., h2) | ||
3. Enter your heading text | ||
4. Set a unique ID in the "Heading ID" field | ||
5. Optional: Adjust alignment and styling | ||
|
||
Advanced Usage | ||
============= | ||
|
||
Styling | ||
------- | ||
|
||
You can apply Bootstrap contextual classes through the "Heading Context" setting: | ||
|
||
- primary | ||
- secondary | ||
- success | ||
- danger | ||
- warning | ||
- info | ||
- light | ||
- dark | ||
|
||
For example, selecting "primary" will add the ``text-primary`` class. | ||
|
||
TOC Integration | ||
-------------- | ||
|
||
To make a heading appear in a Table of Contents: | ||
|
||
1. The heading **must** have an ID set | ||
2. The TOC plugin must be placed **after** the heading in the content flow | ||
3. Only headings with IDs will appear in the TOC | ||
|
||
See the :doc:`Table of Contents </plugins/toc>` documentation for more details. |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,65 @@ | ||
################### | ||
Table of Contents | ||
################### | ||
|
||
The Table of Contents (TOC) plugin automatically generates a navigation list from headings in your content. | ||
|
||
**Important**: The TOC plugin must be placed **after** the headings it references in the content flow. | ||
|
||
************* | ||
How it Works | ||
************* | ||
|
||
The TOC plugin: | ||
|
||
1. Scans for Heading plugins that appear before it in the content | ||
2. Collects headings that have an ID set | ||
3. Generates a nested list of links to those headings | ||
|
||
Basic Usage | ||
========== | ||
|
||
To create a table of contents: | ||
|
||
1. Add your Heading plugins with IDs set | ||
2. Add the TOC plugin after the headings | ||
3. The TOC will automatically generate when the page renders | ||
|
||
Positioning at Top of Page | ||
========================= | ||
|
||
Since the TOC must be placed after headings to collect them, use grid layouts to display it at the top: | ||
|
||
Two Column Layout Example | ||
------------------------ | ||
|
||
1. Create a container | ||
2. Add a row with two columns | ||
3. In the first (left) column: | ||
- Add the TOC plugin | ||
4. In the second (right) column: | ||
- Add your content with Heading plugins | ||
5. Set column widths appropriately (e.g., 3/9 split) | ||
|
||
Example Structure:: | ||
|
||
Container | ||
└── Row | ||
├── Column (col-3) | ||
│ └── TOC Plugin | ||
└── Column (col-9) | ||
├── Heading Plugin | ||
├── Content... | ||
├── Heading Plugin | ||
└── More content... | ||
|
||
This creates a sidebar layout with the TOC always visible while scrolling through content. | ||
|
||
Best Practices | ||
============= | ||
|
||
1. Always set IDs on headings that should appear in the TOC | ||
2. Use consistent heading levels for proper hierarchy | ||
3. Keep heading IDs unique across the page | ||
4. Consider using the grid layout pattern for better UX | ||
5. Test navigation on both desktop and mobile views |