Authoring an html article is like authoring a normal html page, except you just
need to focus on the contents of the <body>.
<h1>Hello There</h1>
<article>
<p>Helpful article content</p>
</article>
Custom pages
If you need a truly custom page (including the header), you can create a custom handlebars template. See documentation (TODO) for how to do this.
The markdown renderer supports the standard information in github-flavored markdown, using marked.js as the renderer. The following plugins are also available for use:
Standard html tags can also be used within markdown docs.
The markdown code for this section is as follows:
Purposefully unformatted
This section is purposefully not parsed as markdown in the example doc,so as to illustrate the markdown format.
The markdown renderer supports the standard information in
[github-flavored markdown](https://marked.js.org/using_advanced#options),
using [marked.js](https://marked.js.org) as the renderer. The following plugins
are also available for use:
#### Plugins {#markdown-renderer-plugins}
- [Admonition](https://www.npmjs.com/package/marked-admonition-extension) for
callouts
- [Custom Heading Id](https://www.npmjs.com/package/marked-custom-heading-id)
for adding custom ids to headings
- [highlight.js](https://www.npmjs.com/package/marked-highlight) for code
syntax highlighting
Standard <code>html</code> <em>tags</em> can also be used within markdown docs.
Default code sample
<h1>html code sample</h1>
console.log("javascript code sample")
To create a callout, the syntax is as per the admonition library.
!!! <type> <optional message>
<optional body>
!!!
In its simplest form, only two lines are necessary, e.g. in this example for an abstract callout:
!!! abstract demo for **abstract**
!!!
As rendered:
demo for abstract
demo for abstract bonus edition
This 'abstract' callout also illstrates what happens to multi-line comments that should wrap and have correct padding, but the comment needs to be long to wrap. /shrug
demo for attention
content for attention
demo for bug
content for bug
demo for caution
content for caution
demo for danger
content for danger
demo for error
content for error
demo for example
content for example
demo for failure
content for failure
demo for hint
content for hint
demo for info
content for info
demo for note
content for note
demo for question
content for question
demo for quote
content for quote
demo for success
content for success
demo for tip
content for tip
demo for warning
content for warning