TOC for Wiki Pages

[MorphBonehunter]

• Gitea version (or commit ref): 1.0.1
• Git version: 2.11.0
• Operating system: Arch Linux
• Database (use [x]):
  • PostgreSQL
  • MySQL
  • SQLite
• Can you reproduce the bug at https://try.gitea.io:
  • Yes (provide example URL)
  • No
  • Not relevant
• Log gist:

Description

This is an "clone" of gogs issue 3931
Having an TOC in Wiki Pages could be helpfull.

---

Want to back this issue? Post a bounty on it! We accept bounties via Bountysource.

[lunny]

It seems it's already supported?

[MorphBonehunter]

A table of contents is supported in Gittea? I mean an TOC based on headings in the Wiki Pages.
Then i do not know how to use it (could not find anything).
The original GOGS Issue is still open and so i think if this works, it was implemented in this project only.

[lunny]

could you see https://try.gitea.io/lunny/vscode/wiki, is the right bar what you want?

[MorphBonehunter]

@lunny although this is an cool feature (is this already implemented?) i mean such thing like this: https://i.stack.imgur.com/IgJJd.png

[lunny]

@MorphBonehunter yes, https://try.gitea.io/lunny/vscode/wiki is the demo of the master. I see what's you want. The content is generated automatically by a special syntax?

[MorphBonehunter]

@lunny yes that's what i thought about. Maybe this isn't possible with an markup renderer atm.
I thought something like this in an README.md:

%%TOC%%

# heading one
# heading two
## subheading

and the %%TOC%% is replaced with:

  1. heading one
  2. heading two
    2.1 subheading

Maybe this could not realized and we are bound to such things like https://github.com/thlorenz/doctoc and have to generate the TOC befor commit.

[zettar]

TOC is really important. Documentation (written in English) is IMHO just as important as the code, which is "a kind of" of English too. With code, we have all sorts of neat code browsers. With documentation, a TOC is a navigation aid, which helps review the content. The search feature is also critical but that's covered by another issue #3760

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs during the next 2 weeks. Thank you for your contributions.

[fangchin]

It's a pity that so little attention is paid to one of the most critical factors of a successful software project: the documentation. When multiple pages are authored, TOCs are a critical part of the overall structure. IMHO this issue deserves far more attention than what it has got so far.

[lafriks]

@fangchin feel free to submit PR for this