Skip to content

Commit 557f6a4

Browse files
antfuantfu
committed
feat: init
0 parents  commit 557f6a4

24 files changed

+10112
-0
lines changed

‎.editorconfig‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
root = true
2+
3+
[*]
4+
indent_size = 2
5+
indent_style = space
6+
end_of_line = lf
7+
charset = utf-8
8+
trim_trailing_whitespace = true
9+
insert_final_newline = true
10+
11+
[*.md]
12+
trim_trailing_whitespace = false

‎.eslintignore‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
dist
2+
node_modules

‎.eslintrc‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"root": true,
3+
"extends": ["@antfu"]
4+
}

‎.gitignore‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
# Dependencies
2+
node_modules
3+
4+
# Logs
5+
*.log*
6+
7+
# Temp directories
8+
.temp
9+
.tmp
10+
.cache
11+
12+
# Yarn
13+
**/.yarn/cache
14+
**/.yarn/*state*
15+
16+
# Generated dirs
17+
dist
18+
19+
# Nuxt
20+
.nuxt
21+
.output
22+
.data
23+
.vercel_build_output
24+
.build-*
25+
.netlify
26+
27+
# Env
28+
.env
29+
30+
# Testing
31+
reports
32+
coverage
33+
*.lcov
34+
.nyc_output
35+
36+
# VSCode
37+
.vscode/*
38+
!.vscode/settings.json
39+
!.vscode/tasks.json
40+
!.vscode/launch.json
41+
!.vscode/extensions.json
42+
!.vscode/*.code-snippets
43+
44+
# Intellij idea
45+
*.iml
46+
.idea
47+
48+
# OSX
49+
.DS_Store
50+
.AppleDouble
51+
.LSOverride
52+
.AppleDB
53+
.AppleDesktop
54+
Network Trash Folder
55+
Temporary Items
56+
.apdisk

‎.npmrc‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
shamefully-hoist=true
2+
strict-peer-dependencies=false

‎.nuxtrc‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
typescript.includeWorkspace=true

‎README.md‎

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
# Nuxt Compile Markdown
2+
3+
4+
[![npm version][npm-version-src]][npm-version-href]
5+
[![npm downloads][npm-downloads-src]][npm-downloads-href]
6+
[![License][license-src]][license-href]
7+
[![Nuxt][nuxt-src]][nuxt-href]
8+
9+
Nuxt Module to compile markdown files into Vue SFC at build time.
10+
11+
## Install
12+
13+
1. Add `nuxt-compile-markdown` dependency to your project
14+
15+
```bash
16+
# Using pnpm
17+
pnpm add -D nuxt-compile-markdown
18+
19+
# Using yarn
20+
yarn add --dev nuxt-compile-markdown
21+
22+
# Using npm
23+
npm install --save-dev nuxt-compile-markdown
24+
```
25+
26+
2. Add `nuxt-compile-markdown` to the `modules` section of `nuxt.config.ts`
27+
28+
```js
29+
export default defineNuxtConfig({
30+
modules: [
31+
'nuxt-compile-markdown'
32+
]
33+
})
34+
```
35+
36+
That's it! You can now use My Module in your Nuxt app ✨
37+
38+
## Development
39+
40+
```bash
41+
# Install dependencies
42+
npm install
43+
44+
# Generate type stubs
45+
npm run dev:prepare
46+
47+
# Develop with the playground
48+
npm run dev
49+
50+
# Build the playground
51+
npm run dev:build
52+
53+
# Run ESLint
54+
npm run lint
55+
56+
# Run Vitest
57+
npm run test
58+
npm run test:watch
59+
60+
# Release new version
61+
npm run release
62+
```
63+
64+
<!-- Badges -->
65+
[npm-version-src]: https://img.shields.io/npm/v/nuxt-compile-markdown/latest.svg?style=flat&colorA=18181B&colorB=28CF8D
66+
[npm-version-href]: https://npmjs.com/package/nuxt-compile-markdown
67+
68+
[npm-downloads-src]: https://img.shields.io/npm/dm/nuxt-compile-markdown.svg?style=flat&colorA=18181B&colorB=28CF8D
69+
[npm-downloads-href]: https://npmjs.com/package/nuxt-compile-markdown
70+
71+
[license-src]: https://img.shields.io/npm/l/nuxt-compile-markdown.svg?style=flat&colorA=18181B&colorB=28CF8D
72+
[license-href]: https://npmjs.com/package/nuxt-compile-markdown
73+
74+
[nuxt-src]: https://img.shields.io/badge/Nuxt-18181B?logo=nuxt.js
75+
[nuxt-href]: https://nuxt.com

‎package.json‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
{
2+
"name": "nuxt-compile-markdown",
3+
"version": "0.0.0",
4+
"packageManager": "pnpm@8.6.12",
5+
"description": "My new Nuxt module",
6+
"repository": "your-org/nuxt-compile-markdown",
7+
"license": "MIT",
8+
"type": "module",
9+
"exports": {
10+
".": {
11+
"types": "./dist/types.d.ts",
12+
"import": "./dist/module.mjs",
13+
"require": "./dist/module.cjs"
14+
}
15+
},
16+
"main": "./dist/module.cjs",
17+
"types": "./dist/types.d.ts",
18+
"files": [
19+
"dist"
20+
],
21+
"scripts": {
22+
"prepack": "nuxt-module-build",
23+
"dev": "nuxi dev playground",
24+
"dev:build": "nuxi build playground",
25+
"dev:prepare": "nuxt-module-build --stub && nuxi prepare playground",
26+
"release": "npm run lint && npm run test && npm run prepack && changelogen --release && npm publish && git push --follow-tags",
27+
"lint": "eslint .",
28+
"test": "vitest run",
29+
"test:watch": "vitest watch"
30+
},
31+
"dependencies": {
32+
"@nuxt/kit": "^3.6.5",
33+
"unplugin-vue-markdown": "^0.24.1"
34+
},
35+
"devDependencies": {
36+
"@antfu/eslint-config": "^0.40.2",
37+
"@nuxt/devtools": "latest",
38+
"@nuxt/module-builder": "^0.4.0",
39+
"@nuxt/schema": "^3.6.5",
40+
"@nuxt/test-utils": "^3.6.5",
41+
"@types/node": "^20.5.0",
42+
"changelogen": "^0.5.4",
43+
"eslint": "^8.47.0",
44+
"nuxt": "^3.6.5",
45+
"vitest": "^0.34.1"
46+
}
47+
}

‎playground/app.vue‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
<template>
2+
<NuxtPage />
3+
</template>

‎playground/components/Counter.vue‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
<script setup lang="ts">
2+
const count = ref(0)
3+
</script>
4+
5+
<template>
6+
<button @click="count++">
7+
count is: {{ count }}
8+
</button>
9+
</template>

0 commit comments

Comments
 (0)