项目简介
这是一个Vue Markdown组件,可将本地或远程的 .md 文件以及 markdown 字符串解析为 HTML 进行显示,能帮助开发者在 Vue 应用中轻松添加 Markdown 内容展示功能。
项目的主要特性和功能
- 支持加载并解析本地和远程的 .md 文件。
- 能够解析 markdown 字符串。
- 提供 vue-cli 插件方式安装,简单便捷。
- 可配置 webpack loader,适用于非 vue-cli 项目。
安装使用步骤
1. 获取项目源码
假设用户已经下载了本项目的源码文件。
2. 安装依赖
推荐方式(vue-cli)
bash
vue add qing-markdown
非 vue-cli 方式
bash
npm install qing-markdown qing-markdown-loader
3. 在 Vue 组件中使用
html
<template>
<q-markdown :text="yourMarkdownContent"></q-markdown>
</template>
yourMarkdownContent
可以是本地或远程的 markdown 内容,也可以是 markdown 格式的字符串。本地文件需配置 webpack loader 才能正确加载,远程文件可通过 axios 等请求获取。
注意事项
非 vue-cli 安装时,需配置 qing-markdown-loader 让 webpack 支持加载 .md 文件,具体配置方法见项目说明。关联项目 qing-markdown-loader 和 vue-cli-plugin-qing-markdown 也有相关介绍和使用指南。
License
该项目遵循 MIT 开源协议。
下载地址
点击下载 【提取码: 4003】【解压密码: www.makuang.net】