docsifyjs
Support specifying short-titles for the sidebar from content pages?
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?"
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(?)
I would be willing to try and implement this, but I have not idea where to start?
My understanding is that the title is generated here: https://github.com/docsifyjs/docsify/blob/54cc5f939b9499ae56604f589eef4e3f1c13cdc5/src/core/render/compiler.js#L210
As you see it's taken from str quite directly. But you'd like that it's taken from the config object instead.
Maybe you can try doing something like this in line 238: https://github.com/docsifyjs/docsify/blob/54cc5f939b9499ae56604f589eef4e3f1c13cdc5/src/core/render/compiler.js#L236-L239 and add:
if (config.sidebar) {
nextToc.title = config.sidebar;
}
