Add Markdown support. #78
Closed
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
Markdown support is optional. It is enabled by setting the `format`
property of the configuration object to "markdown."
ReSpec uses marked for parsing Markkdown.
Note that the content of SECTION elements, and P elements with a
class name of "note" or "issue" is also parsed.
The HTML created by the Markdown parser is turned into a nested
structure of SECTION elements, following the strucutre given by
the headings. For example, the following markup:
Title
-----
### Subtitle ###
Here's some text.
### Another subtitle ###
More text.
will be transformed into:
<section>
<h2>Title</h2>
<section>
<h3>Subtitle</h3>
<p>Here's some text.</p>
</section>
<section>
<h3>Another subtitle</h3>
<p>More text.</p>
</section>
</section>
E.g.:
'''
<div>
This is a title
---------------
And this more text.
</div
'''
Gets turned into:
'''
<div>
<h2>This is a title</h2>
<p>And this more text.</p>
</div
'''
Rather than:
'''
<div>
<pre><code>This is a title
---------------
And this more text.</code></pre>
</div
'''
|
Abandoned in favor of https://github.com/darobin/respec/pull/90. |
shikhar-scs
pushed a commit
to shikhar-scs/respec
that referenced
this pull request
Feb 19, 2018
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.
Markdown support is optional. It is enabled by setting the
formatproperty of the configuration object to "markdown."
ReSpec uses marked for parsing Markkdown.
Note that the content of SECTION elements, and P elements with a
class name of "note" or "issue" is also parsed.
The HTML created by the Markdown parser is turned into a nested
structure of SECTION elements, following the strucutre given by
the headings. For example, the following markup:
will be transformed into: