https://github.com/silvanite/vuepress-plugin-markdown-classes

Add class names to markdown generated html in VuePress
https://github.com/silvanite/vuepress-plugin-markdown-classes

Last synced: 28 days ago
JSON representation

Add class names to markdown generated html in VuePress

• Host: GitHub
• URL: https://github.com/silvanite/vuepress-plugin-markdown-classes
• Owner: Silvanite
• Created: 2019-02-10T17:58:42.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2019-06-27T09:58:55.000Z (over 5 years ago)
• Last Synced: 2024-09-21T10:24:03.634Z (about 2 months ago)
• Language: JavaScript
• Size: 6.84 KB
• Stars: 4
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        
# VuePress Plugin to add unique class names to markdown generated html

Additional information about this Plugin can be found at [https://www.marcomark.net/code/vuepress/markdown-classes.html](https://www.marcomark.net/code/vuepress/markdown-classes.html)

## Example

```html

Vuepress

```


## Installation

```sh

npm i @silvanite/vuepress-plugin-markdown-classes

```

Load the plugin inside your `config.js` or in your theme's `index.js`

```js

module.exports = {

    ...

    "plugins": [

        "@silvanite/markdown-classes"

    ]

}

```

## Configuration options

You can overwrite the default configuration if required

```js

module.exports = {

    ...

    "plugins": [

        ["@silvanite/markdown-classes", {

            "prefix": "md",

            "rules": [

                'blockquote_open',

                'bullet_list_open',

                'code_block',

                'hardbreak',

                'heading_open',

                'hr',

                'html_block',

                'html_inline',

                'image',

                'link_open',

                'ordered_list_open',

                'paragraph_open',

                'softbreak',

                'table_open',

            ]

        }]

    ]

}

```

## Support

If you experience any problems with this VuePress Plugin please open a new issue or get in touch on Twitter [@m2de_io](https://twitter.com/m2de_io). Or just look me up anyway, I'd love to hear from you.