@md-plugins/md-plugin-inlinecode

A Markdown-It plugin that enhances inline code rendering by adding customizable CSS classes. This allows for better styling and alignment with design systems, making inline code blocks visually distinct and consistent.

Features

• Adds a customizable CSS class to inline <code> elements.
• Supports a default class that can be overridden via plugin options.
• Enhances the appearance of inline code for better readability and emphasis.

Installation

Install the plugin via your preferred package manager:

1# with pnpm:
2pnpm add @md-plugins/md-plugin-inlinecode
3# with Yarn:
4yarn add @md-plugins/md-plugin-inlinecode
5# with npm:
6npm install @md-plugins/md-plugin-inlinecode

Usage

Basic Setup

1import MarkdownIt from 'markdown-it'
2import { inlinecodePlugin } from '@md-plugins/md-plugin-inlinecode'
3
4const md = new MarkdownIt()
5md.use(inlinecodePlugin, {
6  inlineCodeClass: 'custom-inline-code-class',
7})
8
9const markdownContent = `
10Here is some \`inline code\` in a sentence.
11`
12
13const renderedOutput = md.render(markdownContent)
14
15console.log('Rendered Output:', renderedOutput)

Example Output

The rendered output will include the specified CSS class:

1<p>Here is some <code class="custom-inline-code-class">inline code</code> in a sentence.</p>

Options

The md-plugin-inlinecode plugin supports the following options:

Option	Type	Default	Description
inlineCodeClass	string	'markdown-token'	CSS class to apply to inline <code> tags.

Testing

Run the tests to ensure the plugin behaves as expected:

1pnpm test

Documentation

In case this README falls out of date, please refer to the documentation for the latest information.

License

This project is licensed under the MIT License. See the LICENSE file for details.