forked from mtoensing/simpletoc
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathreadme.txt
113 lines (75 loc) · 5.34 KB
/
readme.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
=== SimpleTOC - Table of Contents Block ===
Contributors: MarcDK
Tags: Gutenberg, block, TOC, Table of Contents, AMP
Requires at least: 5.9
Donate link: https://marc.tv/out/donate
Tested up to: 6.0
Stable tag: 5.0.28
Requires PHP: 7.0
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html
SEO-friendly Table of Contents Gutenberg block. No JavaScript and no CSS means faster loading.
== Description ==
Add a Table of Contents block to your posts and pages. The TOC is a nested list of links to all heading found in the post or page. To use it, simply add a block and search for "SimpleTOC" or just "TOC".
The maximum depth of the toc can be configured in in the blocks' sidebar among many other options. There can hide the headline "Table of Contents" and add your own by using a normal heading block.
SimpleTOC is open-source and developed on [GitHub Pages](https://github.com/mtoensing/SimpleTOC). If you find a bug or have an idea for a feature please feel free to contribute and create a pull request.
= Features =
* Zero configuration: Add the SimpleTOC block to your post and that's it.
* Minimal and valid HTML output.
* No JavaScript or CSS added.
* Designed for Gutenberg.
* Style SimpleTOC with Gutenberg's native group styling options.
* Inherits the style of your theme.
* Translated in [multiple languages](https://translate.wordpress.org/projects/wp-plugins/simpletoc/). Including German, Chinese (Taiwan), Dutch, Brazilian Portuguese, French, Spanish and Latvia.
= Customization =
* Add background and text color with Gutenberg groups.
* Native block support for wide and full width.
* Control the maximum depth of the headings.
* Choose between an ordered and unordered HTML list.
* Toggle list indent.
* Disable the h2 heading of the TOC block and add your own.
= Compatibility =
* GeneratePress and Rank Math support.
* Works with popular AMP plugins.
== Changelog ==
= 5.0.28 =
* Feature: Change the TOC headline in the block options. Thank you Philipp Stracker!
= 5.0.27 =
* Warning: Some features have been moved to "Advances Features" at the bottom of the settings.
* Feature: Toggle the automatic refresh of the TOC block in Gutenberg.
= 5.0.25 =
* Housekeeping: Updated documentation and dependencies.
= 5.0.21 =
* Feature: SimpleTOC updates itself after the post is saved.
= 5.0.17 =
* Feature: Support for custom Anchor IDs in headings. Thank you Matthias Altmann!
= 5.0.9 =
* Works with WordPress 6.0
* Support for paginated posts.
= 4.3 =
* Feature: Add the CSS class "simpletoc-hidden" to the heading block to remove it from the Table of Contents.
= 3.9 =
* Added Brazilian Portuguese translations to the translations. Thanks Ralden Souza!
== Installation ==
SimpleTOC can be found and installed via the Plugin menu within WordPress administration (Plugins -> Add New). Alternatively, it can be downloaded from WordPress.org and installed manually...
In Gutenberg, add a block and search for "SimpleTOC" or just "TOC". Please save your content before you use the block.
== Frequently Asked Questions ==
= How do I add a background color to SimpleTOC using Gutenberg groups? =
Select the block and select "group" in the context menu. Apply "background color", "link color" and "text color" to this group. SimpleTOC will inherit these styles. You would like to use this styled SimpleTOC group next time you write a post? Convert it to a reusable block.
= How do I add smooth scrolling? =
You can optionally add the css class "smooth-scroll" to each link the TOC. Then you can install plugin that uses these classes.
= How do I hide a single heading? =
If you really want to hide a single heading from the table of contents then add the CSS class "simpletoc-hidden" to a heading block. But first of all, think about the reason you want to hide a specific heading. Maybe you want to remove all headins of a specific depth level. Then there is an option for that in the blocks options in Gutenberg. If you think this heading should not be part of the toc maybe it is not needed in the post itself?
= How do I add SimpleTOC to all articles automatically? =
I don’t see an easy solution at the moment. SimpleTOC is only a block that can be placed in your post. If there would be a plugin that adds blocks to every post then this would be the solution. I think this should be another separate plug-in to keep the code of SimpleTOC clean and … well, simple. Maybe someone knows of a plug-in that adds blocks automatically to all posts with some parameters and settings? What about site editing in WordPress? I think the core team is working on something like that. I will keep this post open. If I have gained more knowledge how to solve this I will add this feature.
== Screenshots ==
1. SimpleTOC block in Gutenberg editor.
2. SimpleTOC in the post.
3. Simple but powerful. Customize each TOC as you like.
4. Control the maximum depth of the headings.
5. Style SimpleTOC with Gutenbergs native group styling options.
6. SimpleTOC Advanced Features
== Credits ==
This plugin is forked from [pdewouters](https://github.com/pdewouters/gutentoc) and uses code from [Easy-Table-of-Contents](https://github.com/shazahm1/Easy-Table-of-Contents)
Many thanks to [Tom J Nowell](https://tomjn.com) and and Sally CJ who both helped me a lot with my questions over at wordpress.stackexchange.com
Thanks to Quintus Valerius Soranus for inventing the Table of Contents around 100 BC.