{"id":21383097,"url":"https://github.com/ravenq/markdown-it-vue","last_synced_at":"2025-04-12T19:41:43.377Z","repository":{"id":32918233,"uuid":"146162073","full_name":"ravenq/markdown-it-vue","owner":"ravenq","description":"The vue lib for markdown-it.","archived":false,"fork":false,"pushed_at":"2022-12-10T17:06:49.000Z","size":8416,"stargazers_count":358,"open_issues_count":38,"forks_count":72,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-04-11T22:07:47.722Z","etag":null,"topics":["emoji","markdown","markdown-it","markdown-it-plugin","vue"],"latest_commit_sha":null,"homepage":null,"language":"Vue","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ravenq.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-08-26T07:55:12.000Z","updated_at":"2025-03-31T07:38:23.000Z","dependencies_parsed_at":"2023-01-14T22:45:52.273Z","dependency_job_id":null,"html_url":"https://github.com/ravenq/markdown-it-vue","commit_stats":null,"previous_names":[],"tags_count":14,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ravenq%2Fmarkdown-it-vue","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ravenq%2Fmarkdown-it-vue/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ravenq%2Fmarkdown-it-vue/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ravenq%2Fmarkdown-it-vue/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ravenq","download_url":"https://codeload.github.com/ravenq/markdown-it-vue/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248625056,"owners_count":21135510,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["emoji","markdown","markdown-it","markdown-it-plugin","vue"],"created_at":"2024-11-22T11:19:52.292Z","updated_at":"2025-04-12T19:41:43.351Z","avatar_url":"https://github.com/ravenq.png","language":"Vue","funding_links":[],"categories":[],"sub_categories":[],"readme":"# markdown-it-vue\n\n[![Build Status](https://travis-ci.org/ravenq/markdown-it-vue.svg?branch=master)](https://travis-ci.org/ravenq/markdown-it-vue)\n\n\u003e The vue lib for markdown-it.\n\n## Demo online\n\n[http://www.aqcoder.com/markdown](http://www.aqcoder.com/markdown)\n\n## Install\n\n```sh\nnpm install markdown-it-vue\n```\n## Running Demo\n```bash\nyarn install \u0026\u0026 yarn dev\n```\nopen http://localhost:8080/\n\n## Supports\n\n- Image size and Viewer\n- Official markdown syntax.\n- GFM TOC\n- GFM style\n- emoji\n- [mermaid charts](http://knsv.github.io/mermaid/)\n- [Echarts](http://echarts.baidu.com) **simple only**\n- Flowcharts.js\n- Subscript/Superscript\n- [AsciiMath](http://asciimath.org/)\n- info | error | warning message tip\n\n## Plugin list\n\n- markdown-it\n- markdown-it-emoji\n- markdown-it-sub\n- markdown-it-sup\n- markdown-it-footnote\n- markdown-it-deflist\n- markdown-it-abbr\n- markdown-it-ins\n- markdown-it-mark\n- markdown-it-katex\n- markdown-it-task-lists\n- markdown-it-highlight\n- markdown-it-latex\n- markdown-it-container\n- markdown-it-github-toc\n- markdown-it-source-map\n- markdown-it-link-attributes\n\ninternal plugin list:\n\n- markdown-it-image\n- markdown-it-font-awsome\n- markdown-it-link-attributes\n- markdown-it-highlight\n- markdown-it-plugin-echarts\n- markdown-it-plugin-mermaid\n- markdown-it-plugin-flowchart\n\n## Options\n\nuse `options` property to sepcial the options of markdow-it and markdown-it-plugins.\n\n```html\n\u003cmarkdown-it-vue class=\"md-body\" :content=\"content\" :options=\"options\" /\u003e\n```\n\n```js\noptions: {\n  markdownIt: {\n    linkify: true\n  },\n  linkAttributes: {\n    attrs: {\n      target: '_blank',\n      rel: 'noopener'\n    }\n  }\n}\n```\n\nmore markdown-it options see \u003chttps://markdown-it.github.io/markdown-it/\u003e.\n\namd default plugins options:\n\n```js\n{\n  linkAttributes: {\n    attrs: {\n      target: '_blank',\n      rel: 'noopener'\n    }\n  },\n  katex: {\n    throwOnError: false,\n    errorColor: '#cc0000'\n  },\n  icons: 'font-awesome',\n  githubToc: {\n    tocFirstLevel: 2,\n    tocLastLevel: 3,\n    tocClassName: 'toc',\n    anchorLinkSymbol: '',\n    anchorLinkSpace: false,\n    anchorClassName: 'anchor',\n    anchorLinkSymbolClassName: 'octicon octicon-link'\n  },\n  mermaid: {\n    theme: 'default'\n  },\n  image: {\n    hAlign: 'left',\n    viewer: true\n  }\n}\n```\n\n## More plugins\n\nit can add your plugin to markdown-it-vue by the `use` method.\n\n```js\nthis.$refs.myMarkdownItVue.use(MyMarkdownItPlugin)\n```\n\n## support hilight lang\n\nPR for you lang wich you want.\n\n- html\n- json\n- css\n- shell\n- bash\n- C\n- Java\n- Python\n- C++\n- C#\n- PHP\n- SQL\n- R\n- Swift\n- Go\n- MATLAB\n- Ruby\n- Perl\n- Objective-C\n- Rust\n- Dart\n- Delphi\n- D\n- Kotlin\n- Scala\n- SAS\n- Lisp\n- Lua\n- Ada\n- Fortran\n- PowerShell\n- VBScript\n- VBscript-html\n- Groovy\n- Julia\n- Julia-repl\n- LabVIEW\n- Haskell\n- ActionScript\n- Scheme\n- TypeScript\n- F#\n- Prolog\n- Erlang\n\n## image size\n\n```md\n![image size](https://http://www.aqcoder.com/ravenq-qr.png =50x50)\n![image size](https://http://www.aqcoder.com/ravenq-qr.png =x50)\n![image size](https://http://www.aqcoder.com/ravenq-qr.png =50x)\n```\n\n## about echarts\n\nuse echarts.simple to reduce the bundle size.\n\n## markdown-it-vue-light\n\nmarkdown-it-vue-light remove the mermaid chart to reduce the bundle size.\n\n\u003chttps://github.com/ravenq/markdown-it-vue/issues/24\u003e\n\nfor a small bundle size, it better to import the markdown-it-vue-light.\n\n## Usage\n\n```vue\n\u003ctemplate\u003e\n  \u003cdiv\u003e\n    \u003cmarkdown-it-vue class=\"md-body\" :content=\"content\" /\u003e\n  \u003c/div\u003e\n\u003c/template\u003e\n\n\u003cscript\u003e\nimport MarkdownItVue from 'markdown-it-vue'\nimport 'markdown-it-vue/dist/markdown-it-vue.css'\nexport default {\n  components: {\n    MarkdownItVue\n  },\n  data() {\n    return {\n      content: '# your markdown content'\n    }\n  }\n}\n\u003c/script\u003e\n```\n\nthe light model.\n\n```vue\n\u003ctemplate\u003e\n  \u003cdiv\u003e\n    \u003cmarkdown-it-vue-light class=\"md-body\" :content=\"content\" /\u003e\n  \u003c/div\u003e\n\u003c/template\u003e\n\n\u003cscript\u003e\nimport MarkdownItVueLight from 'markdown-it-vue/dist/markdown-it-vue-light.umd.min.js'\nimport 'markdown-it-vue/dist/markdown-it-vue-light.css'\nexport default {\n  components: {\n    MarkdownItVueLight\n  },\n  data() {\n    return {\n      content: '# your markdown content'\n    }\n  }\n}\n\u003c/script\u003e\n```\n\n## ScreenShot\n\n![markdown-it-vue](https://github.com/ravenq/markdown-it-vue/blob/master/doc/markdown-it-vue.png?raw=true)\n\n## License\n\n[MIT](https://github.com/ravenq/markdown-it-vue/blob/master/LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fravenq%2Fmarkdown-it-vue","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fravenq%2Fmarkdown-it-vue","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fravenq%2Fmarkdown-it-vue/lists"}