Display implementation snippet by reading in source markdown #9
+27
−181
Conversation
This file contains hidden or 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 assumes that we can find the URL of that document in the query string.
Contributor
|
That is a good point ... I am not sure either? Originally, the implementation section was used to allow others to copy and paste all required code, before we had implemented the ability to import this directly from foreign documents ... One thing could be to add a link to the liveeditor that displays the entire code immediately ... Especially for this we had added a new "macro", simply adding |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
The code snippet in the README can (and has) easily fall out of date, compared to the actual code in the preamble. Instead of hoping that they are kept in sync, this loads in the Markdown file and displays the section between two markers. It assumes that the URL of the markdown file can be found in the query string. I don't know how good of an assumption this is.
I'm not sure that this is a good idea. In addition to the worry noted above, this means that the code won't be displayed when the file is viewed on GitHub. But I thought I'd toss the idea out there.