@nuxtjs/mdc 0.1.0 → 0.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +40 -6
- package/dist/module.json +1 -1
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -1,14 +1,35 @@
|
|
|
1
|
+
|
|
2
|
+
|
|
1
3
|
# Nuxt MDC
|
|
2
4
|
|
|
3
|
-
|
|
5
|
+
[![npm version][npm-version-src]][npm-version-href]
|
|
6
|
+
[![npm downloads][npm-downloads-src]][npm-downloads-href]
|
|
7
|
+
[![License][license-src]][license-href]
|
|
8
|
+
[![Nuxt][nuxt-src]][nuxt-href]
|
|
9
|
+
|
|
10
|
+
MDC supercharges regular Markdown to write documents interacting deeply with any Vue component. MDC stands for MarkDown Components.
|
|
11
|
+
|
|
12
|
+
## Features
|
|
13
|
+
|
|
14
|
+
- Mix Markdown syntax with HTML tags or Vue components
|
|
15
|
+
- Unwrap any generated content (ex: `<p>` added by each Markdown paragraph)
|
|
16
|
+
- Use Vue components with named slots
|
|
17
|
+
- Support inline components
|
|
18
|
+
- Add attributes and classes to inline HTML tags
|
|
19
|
+
|
|
20
|
+
Learn more about the MDC syntax on https://content.nuxtjs.org/guide/writing/mdc
|
|
4
21
|
|
|
5
22
|
## Install
|
|
6
23
|
|
|
7
24
|
```bash
|
|
8
|
-
# Using
|
|
9
|
-
yarn add --dev @nuxtjs/mdc
|
|
10
|
-
# Using NPM
|
|
25
|
+
# Using npm
|
|
11
26
|
npm install --save-dev @nuxtjs/mdc
|
|
27
|
+
|
|
28
|
+
# Using yarn
|
|
29
|
+
yarn add --dev @nuxtjs/mdc
|
|
30
|
+
|
|
31
|
+
# Using pnpm
|
|
32
|
+
pnpm add --dev @nuxtjs/mdc
|
|
12
33
|
```
|
|
13
34
|
|
|
14
35
|
Then, add `@nuxtjs/mdc` to the modules section of your `nuxt.config.ts`
|
|
@@ -39,7 +60,7 @@ Render MDC content with `<MDC>` component:
|
|
|
39
60
|
|
|
40
61
|
```html
|
|
41
62
|
<template>
|
|
42
|
-
<MDC :value="md"
|
|
63
|
+
<MDC :value="md" tag="article" />
|
|
43
64
|
</template>
|
|
44
65
|
|
|
45
66
|
<script setup lang="ts">
|
|
@@ -51,7 +72,6 @@ Hello MDC
|
|
|
51
72
|
</script>
|
|
52
73
|
```
|
|
53
74
|
|
|
54
|
-
|
|
55
75
|
## 💻 Development
|
|
56
76
|
|
|
57
77
|
- Clone repository
|
|
@@ -62,3 +82,17 @@ Hello MDC
|
|
|
62
82
|
## License
|
|
63
83
|
|
|
64
84
|
[MIT](./LICENSE) - Made with 💚
|
|
85
|
+
|
|
86
|
+
|
|
87
|
+
<!-- Badges -->
|
|
88
|
+
[npm-version-src]: https://img.shields.io/npm/v/@nuxtjs/mdc/latest.svg?style=flat&colorA=18181B&colorB=28CF8D
|
|
89
|
+
[npm-version-href]: https://npmjs.com/package/@nuxtjs/mdc
|
|
90
|
+
|
|
91
|
+
[npm-downloads-src]: https://img.shields.io/npm/dm/@nuxtjs/mdc.svg?style=flat&colorA=18181B&colorB=28CF8D
|
|
92
|
+
[npm-downloads-href]: https://npmjs.com/package/@nuxtjs/mdc
|
|
93
|
+
|
|
94
|
+
[license-src]: https://img.shields.io/github/license/nuxt-modules/mdc.svg?style=flat&colorA=18181B&colorB=28CF8D
|
|
95
|
+
[license-href]: https://github.com/nuxt-modules/mdc/blob/main/LICENSE
|
|
96
|
+
|
|
97
|
+
[nuxt-src]: https://img.shields.io/badge/Nuxt-18181B?logo=nuxt.js
|
|
98
|
+
[nuxt-href]: https://nuxt.com
|
package/dist/module.json
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@nuxtjs/mdc",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.1",
|
|
4
4
|
"description": "Nuxt MDC module",
|
|
5
5
|
"repository": "nuxt-modules/mdc",
|
|
6
6
|
"license": "MIT",
|
|
@@ -44,7 +44,7 @@
|
|
|
44
44
|
"detab": "^3.0.2",
|
|
45
45
|
"github-slugger": "^2.0.0",
|
|
46
46
|
"hast-util-to-string": "^2.0.0",
|
|
47
|
-
"mdast-util-to-hast": "^13.0.
|
|
47
|
+
"mdast-util-to-hast": "^13.0.2",
|
|
48
48
|
"micromark-util-sanitize-uri": "^2.0.0",
|
|
49
49
|
"property-information": "^6.2.0",
|
|
50
50
|
"rehype-external-links": "^2.1.0",
|
|
@@ -54,7 +54,7 @@
|
|
|
54
54
|
"rehype-sort-attributes": "^4.0.0",
|
|
55
55
|
"remark-emoji": "^4.0.0",
|
|
56
56
|
"remark-gfm": "^3.0.1",
|
|
57
|
-
"remark-mdc": "^
|
|
57
|
+
"remark-mdc": "^2.0.0",
|
|
58
58
|
"remark-parse": "^10.0.2",
|
|
59
59
|
"remark-rehype": "^10.1.0",
|
|
60
60
|
"scule": "^1.0.0",
|