Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Proposal: numbering all section levels #19

Open
rswgnu opened this issue Oct 23, 2020 · 2 comments
Open

Proposal: numbering all section levels #19

rswgnu opened this issue Oct 23, 2020 · 2 comments

Comments

@rswgnu
Copy link

rswgnu commented Oct 23, 2020

This is fantastic. Thanks for the effort.

I would suggest numbering the sections so people can refer to them.

@p3r7
Copy link
Collaborator

p3r7 commented Oct 24, 2020

Hi

Indeed, that would help, but there are 2 arguments against it:

  • the document is still rapidly evolving and we cannot guarantee that a numeric reference will remain valid for a long time
  • we follow the style of other awesome lists, which doesn't seem to favor numbering

An alternative when it comes to referring a section is simply link to it. Each section header provides an anchor.
E.g.Development Tools > Code Editing > Jump to definition > elisp-defcan be shared (and referred to) as https://github.com/p3r7/awesome-elisp#elisp-def.

There is just one limitation: html anchors have no notion of hierarchy (IMHO, they did a bad design on this).
We currently have an issue w/ elisp-demos which is listed under both Resources > Cookbooks and Development Tools > Documentation & Introspection. A way to circumvent this would be to alter one of the title to generate a different html anchor reference.

@rswgnu
Copy link
Author

rswgnu commented Oct 24, 2020 via email

@p3r7 p3r7 changed the title Add numbers to all section levela Proposal: numbering all section levels Oct 28, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants