https://github.com/fsegurai/marked-extensions
Marked extensions to expand the standard MarkedJS markdown parser with additional features.
https://github.com/fsegurai/marked-extensions
accordion alert comments embeds extensions footnote kanban lists markdown markedjs slide spoiler tables tabs timeline typographic
Last synced: 4 months ago
JSON representation
Marked extensions to expand the standard MarkedJS markdown parser with additional features.
- Host: GitHub
- URL: https://github.com/fsegurai/marked-extensions
- Owner: fsegurai
- License: mit
- Created: 2024-11-21T22:10:31.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2026-03-10T05:27:14.000Z (4 months ago)
- Last Synced: 2026-03-10T11:14:03.494Z (4 months ago)
- Topics: accordion, alert, comments, embeds, extensions, footnote, kanban, lists, markdown, markedjs, slide, spoiler, tables, tabs, timeline, typographic
- Homepage: https://fsegurai.github.io/marked-extensions/
- Size: 1.49 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
**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](#installation)
- [Usage](#usage)
- [Basic Usage](#basic-usage)
- [More Resources](#more-resources)
- [Available Extensions](#available-extensions)
- [Demo Application](#demo-application)
- [Local Development](#local-development)
- [License](#license)
## Installation
Import the desired extension from the available list and apply it to your Marked instance as shown below.
## Usage
### Basic Usage
```javascript
import {marked} from "marked";
import markedExtendedTables from "@fsegurai/marked-extended-tables";
// or UMD script
//
//
marked.use(markedExtendedTables());
const exampleMarkdown = `
| H1 | H2 | H3 |
|---------|---------|---------|
| This cell spans 3 columns |||
`;
marked.parse(exampleMarkdown);
```
### Available Extensions
| Extension | Package | Version | Description |
|-------------|--------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------|----------------------------------------------------------------------|
| Accordion | [@fsegurai/marked-extended-accordion](https://www.npmjs.com/package/@fsegurai/marked-extended-accordion) |  | Add collapsible accordion sections to your markdown |
| Alert | [@fsegurai/marked-extended-alert](https://www.npmjs.com/package/@fsegurai/marked-extended-alert) |  | Create styled alert boxes for important information |
| Comments | [@fsegurai/marked-extended-comments](https://www.npmjs.com/package/@fsegurai/marked-extended-comments) |  | Add comment sections with author and timestamp metadata |
| Embeds | [@fsegurai/marked-extended-embeds](https://www.npmjs.com/package/@fsegurai/marked-extended-embeds) |  | Easily embed content from various platforms (YouTube, Twitter, etc.) |
| Footnote | [@fsegurai/marked-extended-footnote](https://www.npmjs.com/package/@fsegurai/marked-extended-footnote) |  | Add footnotes with automatic numbering |
| Kanban | [@fsegurai/marked-extended-kanban](https://www.npmjs.com/package/@fsegurai/marked-extended-kanban) |  | Create kanban boards with customizable columns and cards |
| Lists | [@fsegurai/marked-extended-lists](https://www.npmjs.com/package/@fsegurai/marked-extended-lists) |  | Enhanced list formatting options |
| Slide | [@fsegurai/marked-extended-slide](https://www.npmjs.com/package/@fsegurai/marked-extended-slide) |  | Create slide decks directly from markdown content |
| Spoiler | [@fsegurai/marked-extended-spoiler](https://www.npmjs.com/package/@fsegurai/marked-extended-spoiler) |  | Hide content behind spoiler tags |
| Tables | [@fsegurai/marked-extended-tables](https://www.npmjs.com/package/@fsegurai/marked-extended-tables) |  | Advanced table formatting with cell spanning |
| Tabs | [@fsegurai/marked-extended-tabs](https://www.npmjs.com/package/@fsegurai/marked-extended-tabs) |  | Create tabbed content sections |
| Timeline | [@fsegurai/marked-extended-timeline](https://www.npmjs.com/package/@fsegurai/marked-extended-timeline) |  | Display content in an interactive timeline format |
| Typographic | [@fsegurai/marked-extended-typographic](https://www.npmjs.com/package/@fsegurai/marked-extended-typographic) |  | Improve typography with smart quotes, dashes, and more |
### Demo Application
To see all extensions in action, check out the [[DEMO]](https://fsegurai.github.io/marked-extensions).
### Local Development
> I highly recommend using "bun" to manage the project dependencies.
To set up the demo locally, follow the next steps:
```shell
git clone https://github.com/fsegurai/marked-extensions.git
bun install
bun start
```
This will serve the application locally at [http://[::1]:8000](http://[::1]:8000).
### Semantic Versioning
The expected commits format follows the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/)
specification. Example:
- feat: add new markdown extension for spoilers
- fix: resolve issue with user profile update
- docs: update API documentation
- style: format code according to new style guide
- refactor: simplify user authentication logic
- test: add or fix unit tests for user registration
- chore: update build process or dependencies
- perf: improve database query performance
## License
Licensed under [MIT](https://opensource.org/licenses/MIT).