-
-
Notifications
You must be signed in to change notification settings - Fork 393
markdown
You can use markdown to write ReSpec based documents. But you must follow markdown's rules carefully.
To enable markdown globally, set format
to "markdown" (see below). And, in the <body>
, make sure you keep all text flushed to the left. This is required because whitespace is significant in Markdown.
<script>
var respecConfig = {
format: "markdown"
}
</script>
<body>
## This is a heading
I'm a paragraph.
* list item
* another list item
The markdown is interpreted as Github Flavored Markdown (GFM) and you can mix HTML and markdown.
Now, we describe some of the ReSpec specific markdown behaviors and extensions.
When using markdown, you don't need to add <section>
elements manually. Each heading automatically creates a structure of nested section elements around it. For example:
## Heading
Here's some text.
### Sub heading
More text.
will be transformed into:
<section>
<h2>Heading</h2>
<p>Here's some text.</p>
<section>
<h3>Sub heading</h3>
<p>More text.</p>
</section>
</section>
By default, ReSpec uses heading's text content to generate IDs for you. The IDs are mostly stable, i.e., we make sure updates to ReSpec do not change the IDs). Sometimes, you might want to add a different (perhaps shorter) ID. You can provide a custom heading ID as:
## I'm a heading {#custom-heading-id}
You can use triple-backticks to create code-blocks (<pre>
elements). Syntax highlighting for various languages, including an advanced syntax highlighter for WebIDL is available out of the box.
```js
function hello() {
console.log("hey!");
}
```
And for WebIDL:
```webidl
[Exposed=Window]
interface Paint { };
```
Please remember that markdown requires double newlines between an HTML tag and markdown text.
Whitespace is also significant! So, keep things aligned to the left.
<aside class="note">
## Markdown inside HTML tags
This is the correct way to insert markdown inside HTML.
</aside>
💖 Support ReSpec by becoming a sponsor via Open Collective. 💖
✨ View rendered version of this documentation at https://respec.org/docs/ ✨
- addSectionLinks
- authors
- caniuse
- edDraftURI
- editors
- favicon
- format (markdown)
- formerEditors
- github
- highlightVars
- isPreview
- license
- lint
- localBiblio
- logos
- maxTocLevel
- mdn
- modificationDate
- noTOC
- otherLinks
- pluralize
- postProcess
- preProcess
- previousDiffURI
- previousMaturity
- previousPublishDate
- prevRecShortname
- prevRecURI
-
processVersion(Deprecated) - publishDate
-
refNote(Deprecated) - shortName
- specStatus
- subjectPrefix
- subtitle
- testSuiteURI
- xref
- additionalCopyrightHolders
-
addPatentNote(Deprecated) - alternateFormats
- canonicalURI
- charterDisclosureURI
- copyrightStart
- crEnd
-
darkMode(deprecated, use dark mode) - doJsonLd
- errata
- group
- implementationReportURI
- lcEnd
- level
- noRecTrack
- prevED
- submissionCommentNumber
-
wg(Deprecated) -
wgId(Deprecated) -
wgPatentPolicy(Deprecated) -
wgPatentURI(Deprecated) - wgPublicList
-
wgURI(Deprecated)
a11y
check-punctuation
local-refs-exist
no-headingless-sections
no-http-props
no-unused-vars
no-unused-dfns
informative-dfn
privsec-section
wpt-tests-exist
Handled by ReSpec for you.
- data-abbr
-
data-cite(Not recommended) - data-dfn-for
- data-dfn-type
- data-format
- data-include-format
- data-include-replace
- data-include
- data-link-for
- data-link-type
- data-local-lt
- data-lt-no-plural
- data-lt-noDefault
- data-lt
- data-number
- data-oninclude
- data-sort
- data-tests
-
data-transform(Deprecated) - data-type
- dir
- lang