Consistent syntax highlighting in API walkthrough #4542
Merged
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
Consistent syntax highlighting in API walkthrough
|
Note that in https://github.com/telefonicaid/fiware-orion/blob/master/doc/manuals/user/walkthrough_apiv2.md the Markdown document renders correctly.
I understand the fix is for RTD rendeing at https://fiware-orion.readthedocs.io/en/master/user/walkthrough_apiv2.html Currently, we recommend Markdown document over RTD, but of course the fix is welcome :). Thanks! |
That's not obvious! All links on github landing page point to readthedocs. Also web-search for orion prominently shows the readthedocs page. |
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 improves the syntax highlightling of your API walkthrough documentation page. Without this change, the individual snippets are recognized as arbitrary language, rendering it hard or impossible to read. The following screenshot shows an extreme case where a shell command is highlighted as CSS with important bits blacked out.