https://github.com/fsegurai/marked-extensions

Markedjs extensions to expand the standard Github-Flavored renders to support advanced features
https://github.com/fsegurai/marked-extensions

Last synced: 13 days ago
JSON representation

Markedjs extensions to expand the standard Github-Flavored renders to support advanced features

• Host: GitHub
• URL: https://github.com/fsegurai/marked-extensions
• Owner: fsegurai
• License: mit
• Created: 2024-11-21T22:10:31.000Z (2 months ago)
• Default Branch: main
• Last Pushed: 2025-01-13T07:15:38.000Z (16 days ago)
• Last Synced: 2025-01-13T08:25:53.209Z (16 days ago)
• Language: JavaScript
• Homepage: https://fsegurai.github.io/marked-extensions/
• Size: 791 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.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)

  - [Using a Specific Extension](#using-a-specific-extension)

  - [Available Extensions](#available-extensions)

  - [Demo Application](#demo-application)

  - [Local Development](#local-development)

- [License](#license)

## Installation

### Using a Specific Extension

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

```typescript

import { marked } from "marked";

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

// or UMD script

// 

// 

marked.use(markedExtendedTables());

marked(`

      | H1                        | H2  | H3  |

      | ------------------------- | --- | --- |

      | This cell spans 3 columns |     |     |

    `);

/**

 * 

 *  

 *    

 *      H1

 *      H2

 *      H3

 *    

 *  

 *  

 *  

 *    This cell spans 3 columns

 *  

 *  

 * 

 */

```

Read the [Marked.js documentation](https://marked.js.org/) for more details about its usage.

### Available Extensions

- [Marked Extended Code Preview](https://github.com/fsegurai/marked-extensions/tree/main/packages/marked-extended-code-preview)

- [Marked Extended Footnote](https://github.com/fsegurai/marked-extensions/tree/main/packages/marked-extended-footnote)

- [Marked Extended Lists](https://github.com/fsegurai/marked-extensions/tree/main/packages/marked-extended-lists)

- [Marked Extended Tables](https://github.com/fsegurai/marked-extensions/tree/main/packages/marked-extended-tables)

- [Marked Extended Typographic](https://github.com/fsegurai/marked-extensions/tree/main/packages/marked-extended-typographic)

### Demo Application

To see all themes in action, check out the [DEMO](https://fsegurai.github.io/marked-extensions/).

### Local Development

To set up the demo locally:

```bash

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

npm install

npm start

```

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

## License

Licensed under [MIT](https://opensource.org/licenses/MIT).