Add three buttons previous page, directory, next page on the bottom of markdown render page when there are a summary.md in the root of tree path. #6690

Closed
opened 2025-11-02 07:03:59 -06:00 by GiteaMirror · 2 comments
Owner

Originally created by @lunny on GitHub (Jan 14, 2021).

It will become convenient for read the book.

Originally created by @lunny on GitHub (Jan 14, 2021). It will become convenient for read the book.
GiteaMirror added the type/proposal label 2025-11-02 07:03:59 -06:00
Author
Owner

@noerw commented on GitHub (Jan 17, 2021):

For reference: This is about making Gitea a renderer of long-form markdown content ("books").
SUMMARY.md is a defacto standard filename for ToC in long-form markdown renderers like mdbook and gitbook.
The format is underspecified, and can differ a lot in handling of relative URLs, indentation, directory traversal, multi-language support

While this feature provides some UX enhancements, I'm not convinced that supporting a parser like this in core Gitea is a good idea. Because of the mentioned ambiguities in the format, there probably will never be a generic, good enough solution.

I've worked with this stuff for a while, trust me, it's a pain.
If really wanted, I'd put this in an external renderer (or do these only work on file-level?)

@noerw commented on GitHub (Jan 17, 2021): For reference: This is about making Gitea a renderer of long-form markdown content ("books"). `SUMMARY.md` is a defacto standard filename for ToC in long-form markdown renderers like [mdbook](https://github.com/rust-lang/mdBook) and [gitbook](https://www.gitbook.com). The format is underspecified, and can differ a lot in handling of relative URLs, indentation, directory traversal, multi-language support While this feature provides some UX enhancements, I'm not convinced that supporting a parser like this in core Gitea is a good idea. Because of the mentioned ambiguities in the format, there probably will never be a generic, good enough solution. I've worked with this stuff for a while, trust me, it's a pain. If really wanted, I'd put this in an external renderer (or do these only work on file-level?)
Author
Owner

@techknowlogick commented on GitHub (Jan 17, 2021):

I think this should be left up to external tools such as gitbook or mdbook

@techknowlogick commented on GitHub (Jan 17, 2021): I think this should be left up to external tools such as gitbook or mdbook
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github-starred/gitea#6690