docs(v2:) Divide markdown-features/code-blocks to smaller sections
#5061
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
This PR adds few more heading to split the content to small topics. This way users like me will be able to scroll directly to the specific section, instead of reading all the documentation. I add to read the entire section because It was not divided into sections. Not a great user experience.
|
|
|
✔️ [V2] 🔨 Explore the source changes: d286b91 🔍 Inspect the deploy log: https://app.netlify.com/sites/docusaurus-2/deploys/60d5c35ef92a2d0008254641 😎 Browse the preview: https://deploy-preview-5061--docusaurus-2.netlify.app |
|
⚡️ Lighthouse report for the changes in this PR:
Lighthouse ran on https://deploy-preview-5061--docusaurus-2.netlify.app/ |
Josh-Cena
reviewed
Jun 25, 2021
| @@ -142,6 +146,8 @@ html[data-theme='dark'] .docusaurus-highlight-code-line { | |||
| } | |||
| ``` | |||
|
|
|||
| ## Multiple line highlighting {#multiple-line-highlighting} | |||
There was a problem hiding this comment.
I think the structure should be more like:
## Line highlighting
### Multiple line highlighting
### Highlighting with commentsAlso, be ware that the section titles should be in sentence case.
There was a problem hiding this comment.
Good catch, thank you for noticing. It was fixed.
slorber
added
the
pr: documentation
slorber
changed the title
markdown-features/code-blocks to smaller sectionsmarkdown-features/code-blocks to smaller sections
|
Thanks 👍 |
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.
This PR adds few more heading to split the content to small topics.
This way users like me will be able to scroll directly to the specific section, instead of reading all the documentation.
I add to read the entire section because It was not divided into sections. Not a great user experience.