https://github.com/mjorgegulab/vue-markdown-wrapper

Vue Markdown component based on marked library
https://github.com/mjorgegulab/vue-markdown-wrapper

Last synced: about 2 months ago
JSON representation

Vue Markdown component based on marked library

• Host: GitHub
• URL: https://github.com/mjorgegulab/vue-markdown-wrapper
• Owner: mjorgegulab
• License: other
• Created: 2023-08-23T17:52:52.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-10-22T17:55:21.000Z (3 months ago)
• Last Synced: 2024-11-29T12:52:16.191Z (about 2 months ago)
• Language: Vue
• Size: 630 KB
• Stars: 6
• Watchers: 1
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        


  



Vue Markdown component based on marked library 📚📙

## [![CodeQL](https://github.com/mjorgegulab/vue-markdown-wrapper/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/mjorgegulab/vue-markdown-wrapper/actions/workflows/github-code-scanning/codeql) [![Codacy Badge](https://app.codacy.com/project/badge/Grade/96b6ee9771a44138bd3ed6460f210c5d)](https://app.codacy.com/gh/mjorgegulab/vue-markdown-wrapper/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade) [![Known Vulnerabilities](https://snyk.io/test/github/mjorgegulab/vue-markdown-wrapper/badge.svg)](https://snyk.io/test/github/mjorgegulab/vue-markdown-wrapper)

## Install

```bash

yarn add vue-markdown-wrapper

# - or -

npm install vue-markdown-wrapper

```

### Usage Example

```vue

    


        

    


import { VueMarkdown } from 'vue-markdown-wrapper';

export default defineComponent({

    data() {

        return {

            md: null,

        };

    },

    async mounted() {

        // FETCH MARKDOWN SAMPLE

        const __md = await (await fetch('/sample01.md')).text();

        this.md = __md as any;

    },

});

```

#### Results



  

  



### Component Props

| Key Name   | Required | Example         | Default Value | Description                                                                                                  |

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

| `md`       | Yes      | `__hello__`     | `null`        | The markdown text                                                                                            |

| `silent`   | No       | `true \| false` | `false`       | If true, the parser does not throw any exception or log any warning. Any error will be returned as a string. |

| `breaks`   | No       | `true \| false` | `false`       | If true, add 
 on a single line break                                                                     |

| `gfm`      | No       | `true \| false` | `true`        | Use approved Github Flavored                                                                                 |

| `pedantic` | No       | `true \| false` | `false`       | Conform to the original markdown.pl                                                                          |

## Contributing to this project

PRs and Issues are welcome. 😘

## License

Copyright © thewolfx41 - Released under the MIT License.