Inline code
Wrap inline snippets of code with `
.
In this example, `<section></section>` should be wrapped as **code**.
Renders to:
In this example, <section></section>
should be wrapped with code.
HTML:
<p>In this example, <code><section></section></code> should be wrapped with <strong>code</strong>.</p>
Indented code
Or indent several lines of code by at least four spaces, as in:
// Some comments
line 1 of code
line 2 of code
line 3 of code
Renders to:
// Some comments
line 1 of code
line 2 of code
line 3 of code
HTML:
<pre>
<code>
// Some comments
line 1 of code
line 2 of code
line 3 of code
</code>
</pre>
Block code "fences"
Use "fences" ```
to block in multiple lines of code.
``` markup
Sample text here...
```
Sample text here...
HTML:
<pre>
<code>Sample text here...</code>
</pre>
Syntax highlighting
GFM, or "GitHub Flavored Markdown" also supports syntax highlighting. To activate it, simply add the file extension of the language you want to use directly after the first code "fence", ```js
, and syntax highlighting will automatically be applied in the rendered HTML. For example, to apply syntax highlighting to JavaScript code:
```js
grunt.initConfig({
assemble: {
options: {
assets: 'docs/assets',
data: 'src/data/*.{json,yml}',
helpers: 'src/custom-helpers.js',
partials: ['src/partials/**/*.{hbs,md}']
},
pages: {
options: {
layout: 'default.hbs'
},
files: {
'./': ['src/templates/pages/index.hbs']
}
}
}
};
```
Renders to:
grunt.initConfig({
assemble: {
options: {
assets: 'docs/assets',
data: 'src/data/*.{json,yml}',
helpers: 'src/custom-helpers.js',
partials: ['src/partials/**/*.{hbs,md}']
},
pages: {
options: {
layout: 'default.hbs'
},
files: {
'./': ['src/templates/pages/index.hbs']
}
}
}
};
Notices
Posted on
08/07/2025 12:27PM
We have four notice styles and they extend the standard markdown syntax for block quotes. Basically levels of 3 block quote or greater produce notices in 4 colors:
Yellow
>>> Sed adipiscing elit vitae augue consectetur a gravida nunc vehicula. Donec auctor
odio non est accumsan facilisis. Ali...
Blockquotes
Posted on
08/07/2025 12:24PM
For quoting blocks of content from another source within your document.
Add > before any text you want to quote.
> **Fusion Drive** combines a hard drive with a flash storage (solid-state drive) and presents it as a single logical volume with the space of both drives combined.
Renders to:
...
Basic Markdown
Posted on
08/07/2025 12:24PM
Headings
Headings from h1 through h6 are constructed with a # for each level:
# h1 Heading
## h2 Heading
### h3 Heading
#### h4 Heading
##### h5 Heading
###### h6 Heading
Renders to:
h1 Heading
h2 Heading
h3 Heading
h4 Heading
h5 Heading
h6 Heading
HTML:
h1 Heading