Added generated Table of Contents to long documentation pages #13836
Conversation
…esting all the links!)
…ancy from child headings
| @@ -31,6 +31,83 @@ Values containing `#` or `;` must be quoted using `` ` `` or `"""`. | |||
|
|
|||
| **Note:** A full restart is required for Gitea configuration changes to take effect. | |||
|
|
|||
| ## Table of Contents. <!-- omit in toc --> | |||
|
|
|||
| <!-- Keep this list up to date and the links in it working across rewordings of headings using one of these markdown extensions in your IDE of choice: | |||
There was a problem hiding this comment.
do we have to mention the VSCode plugin everywhere?
There was a problem hiding this comment.
I was asking myself the same question. Having (potentially a list of) plugins like that everywhere you have a TOC would cause some bloat and repetition. Having it just once (e.g. in a tooling chapter of the contributing docs) would be cleaner. But then I also doubted whether all contributors would actually read and follow those. I for example was not aware of this https://github.com/go-gitea/gitea/tree/master/docs#install
Either way, using Hugo as suggested below renders this question moot.
GiteaBot
added
the
lgtm/need 2
Codecov Report
@@ Coverage Diff @@
## master #13836 +/- ##
==========================================
- Coverage 42.23% 42.12% -0.11%
==========================================
Files 699 708 +9
Lines 76959 77167 +208
==========================================
+ Hits 32501 32510 +9
- Misses 39091 39307 +216
+ Partials 5367 5350 -17
Continue to review full report at Codecov.
|
|
why not just use Hugo built in TOC: https://gohugo.io/content-management/toc/ ? |
That's a way better solution! I was not aware of Hugo, this functionality or this even this ReadMe: https://github.com/go-gitea/gitea/tree/master/docs#install |
|
Disregard this PR - a better alternative has been suggested. |
|
@h0lg thanks for your effort :) document imprufements are always welcome :) |
* Redo #13836 with new shortcode (https://gitea.com/gitea/theme/pulls/90) * add Api Usage Co-authored-by: techknowlogick <techknowlogick@gitea.io>
... for easier overview & navigation.
Note that