Skip to content
Marcos Cáceres edited this page Jun 7, 2016 · 15 revisions

Tells ReSpec to treat the document as being in a format other than HTML. Supported formats:

"markdown"
Interpreted as GitHub flavored markdown

Example

var respecConfig = {
  format: "markdown",
}

Markdown

When format is set to "markdown", you can use a mix of HTML and markdown:

## Using markdown
This will be a paragraph. 

<pre class="example" title="A markdown example">
function thisIsNice(){
becauseWeCanUseMarkdown();
}

// And using markdown is pretty sweet!
const foo = "FOO";
while(foo){
Promise.all([...lotsOfPromises])
}
</pre>

ReSpec will do its best to correctly format the markdown. Please remember that markdown is supposed to be placed flush against the left margin - but we do support padded sections.

<section>
  ## This is ok
  Event tho it is not flush to the left margin.
</section> 

See also: nolink class to disable automatic linking in code blocks, if needed.

Guides

Configuration options

W3C Configuration options

Linter rules

Internal properties

Handled by ReSpec for you.

Special <section> IDs

HTML elements

Custom Elements

WebIDL

HTML attributes

CSS Classes

Special properties

Clone this wiki locally