https://github.com/daidr/vue-mark

https://github.com/daidr/vue-mark

Last synced: 2 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/daidr/vue-mark
• Owner: daidr
• License: mit
• Created: 2024-01-31T01:46:24.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2024-08-11T13:00:18.000Z (3 months ago)
• Last Synced: 2024-10-11T20:19:28.743Z (about 1 month ago)
• Language: TypeScript
• Size: 193 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Vue Mark

提供了一个便捷的API，将 markdown 快速转换为 VNodes，支持使用自定义 Vue.js (3.0+) 组件。

## 安装

```bash

# use npm

npm install @vuemark/core

# use yarn

yarn add @vuemark/core

# use pnpm

pnpm add @vuemark/core

```

## 开箱即用

```vue

const markdownText = ref('# Hello, Vue Mark!')

const { VueMarkContent, FootnoteContent, hasFootnote } = useVueMark(markdownText)

  


    

    

  


```

## 贡献

如果你有任何问题或者建议，欢迎提 [Issue](https://github.com/daidr/vue-mark/issues) 或者 [PR](https://github.com/daidr/vue-mark/pulls)。

### 开发

> [!WARNING]

> 请使用 `pnpm` 作为你的包管理器。

> [!TIP]

> 建议使用 VS Code 进行开发，并安装推荐插件，默认情况下会自动启动 ESLint 并根据规则进行代码格式化。

```bash

# 安装依赖

pnpm install

# 启动开发环境

pnpm dev

# 构建

pnpm build

```

### 测试

TODO

### 规范

TODO

## 自定义组件

TODO

## API

TODO

## License

[MIT License](LICENSE)