markdown-it-codeblocks
Splits up your header sections into samples and references ie :
#heading1 Here is some sample code ```codevar a = 8;``` description here would get converted to:
heading1 Here is some sample code var a = 8 description here If there are multiple code sections, it will only include up to the last consecuritve code section:
#heading1 Here is some sample code ```codevar a = 8;``` ```codevar a = 2;``` Some more text would get converted to:
heading1 Here is some sample code var a = 8 var a = 2 Some more text But, if there is anything inbetween those sections like:
#heading1 Here is some sample code ```codevar a = 8;``` Some other markdown in between these two code sections ```codevar a = 2;``` Some more text it would get converted to:
heading1 Here is some sample code var a = 8 Some other markdown inbetween these two code sections var a = 2 Some more text Works well when combined with the markdown-it-header-sections plugin!
Table of Contents
Install
npm install -S markdown-it-codeblocks
Usage
With defaults:
const MarkdownItCodeBlocks = ;const MarkdownIt = With custom classes:
const MarkdownItCodeBlocks = ;const MarkdownIt = With level grouping:
const MarkdownItCodeBlocks = ;const MarkdownIt = This would group all headings within the 2 headings that are larger than 2 ie:
## heading2a Some markdown ### inner heading #### another inner heading ## heading2b In this case, everything between heading2a and heading2b will be considered a single section
API
MarkdownItCodeBlocks(md, options)
Parameters:
| Attribute | Type | Required | Description | Default |
|---|---|---|---|---|
md |
String | yes | The input markdown | |
options.sampleClass |
String | no | Class assigned to the sample blocks | 'sample' |
options.referenceClass |
String | no | Class assigned to the reference blocks | 'reference' |
options.levelGrouping |
Integer | no | Allows you to group certain headings into one section. | null |
License
MIT
Changelog
1.0.0 (2017-09-02)
- Release