:TOC: label in "org mode" readme files should be hidden

[finex]

• Gitea version (or commit ref): 1.13.0

• Git version: 2.11.0

• Operating system: Debian (official gitea docker image)

• Database (use [x]):

  • PostgreSQL
  • MySQL
  • MSSQL
  • SQLite

Description

I've created a README.org file using Emacs org mode. The file is something like:

#TITLE: file title

* Table of contents :TOC:
- [[#title][Title]]

* Title
Lorem ipsum...

Usually github/gitlab doesn't show the :TOC: attribute, which is used by Emacs to regenerate the table of contents on save.

Screenshots

Actual result:

Desidered behaviour:

Extra issues

I've found other two "bugs", the first is that if the README already has a TOC, gitea shouldn't render his own index. The second is that the anchors generated using org mode doesn't works. Should I open two separate issues for this two bug?

Thank you.

[a1012112796]

@finex because gitea not support this format now, it consider this file as an simple markdown file.
related issue :#12832. Thanks.

[lunny]

@a1012112796 In fact, we support org-mod on git files but not wikis. This should be a problem of upstream library which Gitea depends on.

[a1012112796]

ok, I see, I will check it and send issue to upstream repo.

[finex]

Thanks!

[niklasfasching]

Usually github/gitlab doesn't show the :TOC: attribute, which is used by Emacs to regenerate the table of contents on save.

I couldn't find anything on the :TOC: label in the org mode docs and haven't seen it before. Could you link me to documentation / example markup that modifies the TOC html in emacs org export? In my tests emacs just ignores it.

(Assuming :TOC: is just a normal tag - i.e. no reason to modify go-org) gitea can modify display of tags using css span.tags { ... }

See my comment in niklasfasching/go-org#44 (comment)

[finex]

Hi, you're right, I was using Doom Emacs and I didn't know (until now) that this feature is not default but it's from the following package installed by Doom: https://github.com/snosov1/toc-org

[niklasfasching]

thx.
as org mode supports positioning the toc using #+TOC I'd opt for implementing that - that would also get rid of the default toc. Fixing the links is up to gitea - they work in raw go-org output.

Would that solve your problem? No promises, would have to check if this is as low hanging fruit as I'm expecting.

[finex]

Hi, yes, it should be good :-)

[niklasfasching]

niklasfasching/go-org@7c239a7
go-org now supports #+TOC: headlines $n - $n being the max headline lvl to include (0 being all).
The default toc has to be disabled manually (#+OPTIONS: toc:nil) as that's the way org mode does it. See #keywords examples (you probably have to scroll the html output to see the toc)

[finex]

Thank you 😄

[lunny]

Once go-org released, we can upgrade the vendor.

[braoult]

There are many reasons to upgrade go-org, many features supported here are not in gitea (VERSE and EXPORT blocks, TODO separate class, ATTR_HTML, etc...).