withLineNumbers?: boolean

• Default: false
• Allowed in Markdown: yes

Set to true to render line numbers.

highlight?: Array >

• Default: []
• Allowed in Markdown: yes

Use this option to specify which lines or ranges of lines should be marked with specified highlighting class (or classes). These classes can be customized via highlightClasses and highlightRangeClasses options.

Examples

• Highlight lines 5 and 7:

  {{ highlight: [5, 7] }}
  

• Highlight lines 5, 7, and lines in range from 10 to 15:

  {{ highlight: [5, 7, [10, 15]] }}
  

highlightClasses?: Array

• Default: ['highlight']
• Allowed in Markdown: no

Use this option to customize classes for highlighted lines.

highlightRangeClasses?: HighlightRangeClasses

• Default: ['highlight-start', 'highlight-inner', 'highlight-end']
• Allowed in Markdown: no

Use this option to customize classes for highlighted ranges. Must be a tuple of exactly three elements.

Explanation

• The first class is assigned to the first line of a range.
• The second class is assigned to all lines between the first and the last line of a range. This only applied if the range covers 3 and more lines.
• The third class is assigned to the last line of a range.

Is this overkill? Probably...

highlightInvert?: boolean

• Default: false
• Allowed in Markdown: yes

Set to true to allow marking lines that are not highlighted with specified classes. These classes can be customised via highlightInvertClasses.

Note: this will work only if highlight option is set to a non-empty array of lines.

highlightInvertClasses?: Array

• Default: ['highlight-invert']
• Allowed in Markdown: no

Use this option to customize classes for unhighlighted lines.

highlighter?: HighlighterOptions

• Default: {}
• Allowed in Markdown: no

Highlighter options which will be passed right into shiki's getHighlighter. See shiki documentation for available options.

API

Besides exposing the shikigami function, this plugin re-exports shiki's loadTheme just for convenience.

shikigami(userOptions?: ShikigamiOptions): Promise

Plugin fabric.

import { shikigami } from '@nrsk/shikigami'
import anchor from 'markdown-it-anchor'
import md from 'markdown-it'

async function processMarkdown(input) {
  return md('commonmark')
    .use(
      await shikigami({
        /** Plugin options. */
      })
    )
    .use(anchor)
    .render(input)
}

loadTheme(themePath: string): Promise

Shiki's theme loader.

Todo

• Tests.
• Diffs support.
• Plugin for remark.
• Plugin for rehype.

License

MIT.