@f3ve/vue-markdown-it

中文文档
0.2.3发布于 2024/10/27MITTypeScriptESM + CJS近 30 天下载 6876

第3个减值组件

中文使用文档
文档目录13 节
  1. 关于项目
  2. 内设
  3. 开始
  4. 先决条件
  5. 安装
  6. 使用量
  7. 导入组件
  8. 使用插件
  9. 使用减记插件
  10. 使用 Markdown- it 选项和预设
  11. 路线图
  12. 捐款
  13. 许可证

Contributors Forks Stargazers Issues MIT License


摇摆下旗

第3个减值组件
探索文件“
报告错误 • 妇女 请求特性

目录
  1. 关于项目
  2. 开始
  3. 使用量
  4. 路线图
  5. 捐款
  6. 许可证
  7. 联系人
  8. 承认

关于项目

这是方便整合的组成部分 缩放 内 第3组。这个项目的灵感来自 减速. 它有一段时间没有更新过,只支持Vue 2.

(单位:千美元)返回顶端(中文(简体) )

内设

  • Vue
  • Vite

(单位:千美元)返回顶端(中文(简体) )

开始

先决条件

  • 第3组
npm i vue

安装

npm i @f3ve/vue-markdown-it

(单位:千美元)返回顶端(中文(简体) )

使用量

导入组件

您可以直接导入您的 SFC 文件的组件 .

单位 <script setup> 语法

<!-- Vue 3 setup script syntax -->
<script setup>
import { VueMarkdownIt } from '@f3ve/vue-markdown-it';

const post = ref();

onMounted(async () => {
  const res = await api.get('/post');
  post.value = res.data;
});
</script>

<template>
  <vue-markdown-it :source="post" />
</template>

定期 <script> 语法

<script setup>
import { VueMarkdownIt } from '@f3ve/vue-markdown-it';

export default {
  components: {
    VueMarkdownIt
  }
  setup() {
    const post = ref();

    onMounted(async () => {
      const res = await api.get('/post');
      post.value = res.data;
    });
  }
}
</script>

<template>
  <vue-markdown-it :source="post" />
</template>

使用插件

您也可以使用插件在全球注册组件 .

// main.js
import { createApp } from 'vue';
import App from './App.vue';
import { VueMarkdownItPlugin } from '@f3ve/vue-markdown-it';

const app = createApp(App);

app.use(VueMarkdownItPlugin);

app.mount('#app');

使用减记插件

您可以使用 plugin 道具 (英语). plugin 需要一系列的下调插件 。 如果您想要配置插件的选项, 您可以在数组中嵌入插件及其选项 .

<script setup>
import { VueMarkdownIt } from '@f3ve/vue-markdown-it';
import myPlugin from 'myPlugin';
import myPluginWithOption from 'myPluginWithOptions';

const post = ref();

onMounted(async () => {
  const res = await api.get('/post');
  post.value = res.data;
});
</script>

<template>
  <vue-markdown-it
    :source="post"
    :plugins="[myPlugin, [myPluginWithOptions, { option1: true }]]"
  />
</template>

使用 Markdown- it 选项和预设

见 标记- 它的文档 更多信息

选项

注意:我用的是Vue语 脚本设置 这些例子中的语法. 如果你没有使用脚本设置 确保 注册组件 在使用之前.

<script setup>
import { VueMarkdownIt } from '@f3ve/vue-markdown-it';

const post = ref();
const options = {
  html: true,
  linkify: true,
};

onMounted(async () => {
  const res = await api.get('/post');
  post.value = res.data;
});
</script>

<template>
  <vue-markdown-it :source="post" :options="options" />
</template>

预设

<script setup>
import { VueMarkdownIt } from '@f3ve/vue-markdown-it';

const post = ref();

onMounted(async () => {
  const res = await api.get('/post');
  post.value = res.data;
});
</script>

<template>
  <vue-markdown-it :source="post" preset="commonmark" />
</template>

一起使用预设和选项

<script setup>
import { VueMarkdownIt } from '@f3ve/vue-markdown-it';

const post = ref();
const options = {
  html: true,
  linkify: true,
};

onMounted(async () => {
  const res = await api.get('/post');
  post.value = res.data;
});
</script>

<template>
  <vue-markdown-it :source="post" :options="options" preset="commonmark" />
</template>

(单位:千美元)返回顶端(中文(简体) )

路线图

见 未决问题 (c) 列出所有拟议特点(和已知问题).

(单位:千美元)返回顶端(中文(简体) )

捐款

见贡献指南

(单位:千美元)返回顶端(中文(简体) )

许可证

分发于 MIT 许可证。 。 。 .

(单位:千美元)返回顶端(中文(简体) )

版本与发布记录

@f3ve/vue-markdown-it 共发布 6 个版本,首次发布于 2023/09/14;过去 12 个月发布了 0 个版本。

版本发布日期距今
0.2.3latest2024/10/272 年前
0.2.22024/04/142 年前
0.2.02023/10/053 年前
0.1.22023/10/053 年前
0.1.12023/09/143 年前
0.1.02023/09/143 年前

关于 @f3ve/vue-markdown-it 的常见问题

@f3ve/vue-markdown-it 是什么?

第3个减值组件

如何安装 @f3ve/vue-markdown-it?

在项目目录运行 npm install @f3ve/vue-markdown-it,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:vue(^3.3.4)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@f3ve/vue-markdown-it 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@f3ve/vue-markdown-it 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@f3ve/vue-markdown-it 可以商用吗?

@f3ve/vue-markdown-it 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@f3ve/vue-markdown-it 的下载量有多少?

根据 npm 官方下载统计,@f3ve/vue-markdown-it 在 2026/10/14 – 2026/11/12 这 30 天内被下载 6,876 次,日均约 229 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@f3ve/vue-markdown-it 还在维护吗?

最新版本 0.2.3 发布于 2024/10/27(2 年前);至今共发布 6 个版本,其中过去 12 个月发布了 0 个;首次发布于 2023/09/14。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。