Mardown Support #38
Merged
Mardown Support #38
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
We don’t really need this, and it might mess up our previewing.
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 pull request contributes markdown support for all free-form text entries that should be able to be styled.
We're using a modified version of Redcarpet for markdown rendering, with many extensions added. Things like tables, autolinking, code blocks like in GFM, footnotes, etc.
In addition to this, the syntax has been extended to support previews. Putting
~~in the document allows the author to specify what content should be used as the preview of the document. For example:In preview mode, using the helper method
render_markdown_preview, as shown inhome/index.html.erb, the content above will render to just "Hello world.", but in full document mode, withrender_markdown, it will render the whole document, without the~~characters.Site areas that display markdown formatted text, but which have not yet been updated from their original scaffolding have not all been converted as these need a full re-write at some point anyway.