2ring-markdown-extension README

The 2Ring Markdown Extension should be used for editing internal documentation files.

Features

The extension contains support for the following markup:

::: classNameOne classNameTwo
content
:::

results in:

<div class="classNameOne classNameTwo">content<div>

:fa-icon:
:fas-icon:
:far-icon:
:fab-icon:

results in:

<i class="fa fa-icon"></i>
<i class="fas fa-icon"></i>
<i class="far fa-icon"></i>
<i class="fab fa-icon"></i>

[ ] for checkboxes
[x] for filled checkboxes

^ok^
^sample:custom^

results in:

<span class="btn btn-primary">ok</span>
<span class="custom">sample</span>

Table of Contents

The extension also looks for the %TABLE_OF_CONTENTS% placeholder line in the markdown file, which will be replaced with an actual table of contents in the preview.

A configuration setting "2r_md.tocLevel" can be set to use a specific heading for the generated table of contents.