https://github.com/jub0t/markdownx

Unleash the Power of Markdown with Tailwind CSS Compatibility
https://github.com/jub0t/markdownx

markdown markdown-parser md parser regex taildown tailwinds tailwinds-markdown tailwindscss

Last synced: 16 days ago
JSON representation

Unleash the Power of Markdown with Tailwind CSS Compatibility

• Host: GitHub
• URL: https://github.com/jub0t/markdownx
• Owner: jub0t
• License: mit
• Created: 2022-02-26T10:26:21.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-04-05T09:42:36.000Z (8 months ago)
• Last Synced: 2024-04-30T23:02:10.576Z (7 months ago)
• Topics: markdown, markdown-parser, md, parser, regex, taildown, tailwinds, tailwinds-markdown, tailwindscss
• Language: TypeScript
• Homepage:
• Size: 3.4 MB
• Stars: 13
• Watchers: 0
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Markdown For Tailwinds

⚡ Markdown parser compatible with Tailwind Css. Prism.js themes can be found [here](./styles).

![Preview](./preview.png)

## Installation

Get the file from Releases, get styles from [here](https://github.com/PrismJS/prism-themes)

## Usage

```js

// Initialized

const Parser = new Tayparser();

```

```js

// Parse Markdown

const MarkdownCode = `

# Blog Post

`;

const Code = Parser.parse(MarkdownCode);

console.log(Code);

```

```js

// Highlight All 
 Snippets

Prism.highlightAll();

```


```js

// Escape HTML

const Markdown = new TailDown({ escapeHTML: true });

```

## Config

```js

const Markdown = new TailDown({

  a: {

    customClass: "hover:text-blue-500",

    extendStyle: "display: block;",

  },

  h3: {

    customClass: "text-gray-600",

    extendStyle: "display: block;",

  },

});

```