cirosantilli.github.io icon indicating copy to clipboard operation
cirosantilli.github.io copied to clipboard

question(guide): header length examples

Open Kristinita opened this issue 6 years ago • 1 comments

1. Summary

Can be added more detailed rationale, why headers must be «as short as possible»? Can you add more examples?

2. Details

Markdown-style-guide citation:

Rationale: it is easier to refer to the header later, specially if automatic IDs or a TOC are generated by the implementation.

I use:

  1. Sublime Text autocompletes, that can autocomplete header.
  2. MarkdownTOC — Sublime Text package, that automatically generate TOC and ids for headers.

On the contrary, that when TOC and ids are automatically generated, the length of the header does not matter to me.

Thanks.

Kristinita avatar Feb 10 '19 07:02 Kristinita

Further clarified at: https://github.com/cirosantilli/markdown-style-guide/commit/8460711ed453b3b50c04fbd79570cdd174566ab9

cirosantilli avatar Feb 10 '19 10:02 cirosantilli