[IMP] readme template: subsection instructions #460
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
pedrobaeza
reviewed
Jun 11, 2020
| @@ -3,3 +3,6 @@ | |||
| This module extends the functionality of ... to support ... | |||
| and to allow you to ... | |||
|
|
|||
| Fragments may contain section titles. The first title level must be underlined | |||
| with the ``~`` (tilde) character. Subsections can be underlined using any | |||
| non-alphanumeric character, other than ``~``, ``=`` and ``-``. | |||
There was a problem hiding this comment.
Examples of these allowed non-alphanumeric characters?
|
@dreispt thank you for clarifying this. I think if we want to allow more than one level in fragments we need to say explicitly which underline character to use. Otherwise we risk blocking the evolution of other auto generated sections, or prevent the combination of several readmes in a single documents. |
|
@dreispt OK, I see the point, I will propose levels. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Explain how to add sections and subsections in README fragments.