File tree Expand file tree Collapse file tree 1 file changed +63
-1
lines changed
Expand file tree Collapse file tree 1 file changed +63
-1
lines changed Original file line number Diff line number Diff line change 1- ###################
1+ ##############################
2+ Headings and table of contents
3+ ##############################
4+
5+ *********
6+ Heading
7+ *********
8+
9+ The Heading plugin allows you to add headings (h1-h6) to your content with optional styling and anchors for navigation.
10+
11+ Configuration
12+ *************
13+
14+ - **Heading Level **: Choose h1-h6 for the heading tag
15+ - **Heading Text **: The text content of the heading
16+ - **Heading ID **: Optional anchor ID for TOC linking
17+ - **Heading Alignment **: Text alignment (left, center, right)
18+ - **Heading Context **: Optional Bootstrap contextual class for styling
19+
20+ Example
21+ =======
22+
23+ Basic heading::
24+
25+ <h2 id="my-section">My Section Title</h2>
26+
27+ To create a heading that will appear in a table of contents:
28+
29+ 1. Add a Heading plugin
30+ 2. Set the heading level (e.g., h2)
31+ 3. Enter your heading text
32+ 4. Set a unique ID in the "Heading ID" field
33+ 5. Optional: Adjust alignment and styling
34+
35+ Advanced Usage
36+ =============
37+
38+ Styling
39+ -------
40+
41+ You can apply Bootstrap contextual classes through the "Heading Context" setting:
42+
43+ - primary
44+ - secondary
45+ - success
46+ - danger
47+ - warning
48+ - info
49+ - light
50+ - dark
51+
52+ For example, selecting "primary" will add the ``text-primary `` class.
53+
54+ TOC Integration
55+ --------------
56+
57+ To make a heading appear in a Table of Contents:
58+
59+ 1. The heading **must ** have an ID set
60+ 2. The TOC plugin must be placed **after ** the heading in the content flow
61+ 3. Only headings with IDs will appear in the TOC
62+
63+ *******************
264 Table of Contents
365###################
466
You can’t perform that action at this time.
0 commit comments