docsifyjs / docsifyjs/docsify

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

Open
#1,821 3 comments 1 reaction 0 assignees View on GitHub
Dominant language
JavaScript
Stars
31.5k
Forks
5.8k
Avg merge
9d 8h
Merged PRs (30d)
2

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](https://docsify.js.org/#/helpers?id=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](https://user-images.githubusercontent.com/19333579/174432003-2e234fb2-3527-441c-87e0-e0244240be4a.png)

#### 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](/docsifyjs/docsify/issues/1290) 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(?)

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.