A library of custom extensions for Marked.js

@fsegurai/marked-extensions is a collection of custom extensions for Marked.js, making it more powerful and versatile.

Table of contents

• Installation
• Usage
  • Basic Usage
• More Resources
  • Available Extensions
  • Demo Application
  • Local Development
• License

Installation

Import the desired extension from the available list and apply it to your Marked instance as shown below.

Usage

Basic Usage

import {marked} from "marked";
import markedExtendedTables from "@fsegurai/marked-extended-tables";

// or UMD script
// <script src="https://cdn.jsdelivr.net/npm/marked/lib/marked.umd.js"></script>
// <script src="https://cdn.jsdelivr.net/npm/@fsegurai/marked-extended-tables/lib/index.umd.js"></script>

marked.use(markedExtendedTables());

const exampleMarkdown = `
| H1      | H2      | H3      |
|---------|---------|---------|
| This cell spans 3 columns |||
`;

marked.parse(exampleMarkdown);

Available Extensions

Extension	Version	Description
Marked Extended Accordion		Add collapsible accordion sections to your markdown
Marked Extended Alert		Create styled alert boxes for important information
Marked Extended Footnote		Add footnotes with automatic numbering
Marked Extended Lists		Enhanced list formatting options
Marked Extended Spoiler		Hide content behind spoiler tags
Marked Extended Tables		Advanced table formatting with cell spanning
Marked Extended Tabs		Create tabbed content sections
Marked Extended Timeline		Display content in an interactive timeline format
Marked Extended Typographic		Improve typography with smart quotes, dashes, and more

Demo Application

To see all extensions in action, check out the [DEMO].

Local Development

I highly recommend using "bun" to manage the project dependencies.

To set up the demo locally, follow the next steps:

git clone https://github.com/fsegurai/marked-extensions.git
bun install
bun start

This will serve the application locally at http://[::1]:8000.

Semantic Versioning

The expected commits format follows the Conventional Commits specification. Example:

• feat: add new user login feature
• fix: resolve issue with user profile update
• docs: update API documentation
• style: format code according to new style guide
• refactor: simplify user authentication logic
• perf: improve database query performance
• test: add tests for user registration

License

Licensed under MIT.