Use Markdown-it 🚀

项目简介 📦

Use Markdown-it 是基于 markdown-it 的 Vue 3 封装，提供便捷的 Markdown 渲染功能，帮助开发者在应用中快速渲染 Markdown 内容。

功能特点 ✨

Markdown 渲染 📝

• ✨ 支持 CommonMark 和 GitHub Flavored Markdown
• 🎨 提供丰富的插件生态
• ⚡ 高性能渲染引擎

模块化设计 🧩

• 📁 采用模块化架构，组件独立封装
• 📦 支持按需导入，减小打包体积
• 🔧 清晰的文件结构，易于维护和扩展

类型安全 🔒

• 📝 完整的 TypeScript 类型定义
• 💡 提供准确的类型推断和代码提示
• 🎯 支持 Vue 3 的 Composition API 类型系统

轻量高效 ⚡

• 🚀 核心代码精简，无额外依赖
• 🏃 优化的性能表现，最小化运行时开销
• 📦 支持 Tree Shaking，进一步减小打包体积

安装 📥

使用 pnpm 🐱

pnpm add @oiij/markdown-it

使用 npm 📦

npm install @oiij/markdown-it

使用 yarn 🧶

yarn add @oiij/markdown-it

快速开始 🌟

基础使用

<script setup>
import { UseMarkdownIt } from '@oiij/markdown-it'
</script>

<template>
  <UseMarkdownIt content="# Hello World" />
</template>

在线文档 📚

在线文档 📖

贡献指南 🤝

欢迎贡献代码、报告问题或提出新功能建议！

1. Fork 本仓库 🍴
2. 创建您的特性分支 (git checkout -b feature/amazing-feature) 🌿
3. 提交您的更改 (git commit -m 'Add some amazing feature') 💾
4. 推送到分支 (git push origin feature/amazing-feature) 🚀
5. 打开一个 Pull Request 📥

许可证 📄

本项目采用 MIT 许可证 - 查看 LICENSE 文件了解详情 📑

联系方式 📞

• GitHub: https://github.com/Eiog/@oiij/markdown-it 🌟