Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Support specifying short-titles for the sidebar from content pages? #1821

Open
@Jacco-V

Description

Feature request

What problem does this feature solve?

This feature would allow long titles for the documentation headers, with short titles in the sidebar, when needed. Right now, this can be done by manually creating each and every entry for the sidebar, but this:

a) takes a lot of time,
b) is very prone to errors, and
c) forces you to write each and every sidebar entry yourself, even if short-titles are only required for a couple of entries.

What does the proposed API look like?

How should this be implemented in your opinion?

Right now, Docsify supports Customise ID for headings. It would be great if it would also support something like:

## How would I write a "hello, world" example? :sidebar="hello world?"

image

Are you willing to work on this yourself?

Willing? yes, but realistically, I don't now how to do frontend development.

Relation to other issues?

This issue has of course some relation to Proposal: auto generate sidebar but as far as I can see the two are not the same, and I suspect the difficulties that would be part auto-generating the entire sidebar do not apply to only generating the in-page links(?)

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions

        AltStyle によって変換されたページ (->オリジナル) /