initial commit

Signed-off-by: YouXam <[email protected]>

Author: YouXam

.gitignore

@@ -0,0 +1,4 @@
+dist/
+node_modules/
+public/
+.DS_Store

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 YouXam
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,114 @@
+# mdvc
+
+mdvc (markdown-vue-component) is a library to compile markdown/vue/js/ts/css files to vue components directly in your browser.
+
+## Installation
+
+```bash
+npm install mdvc
+# or
+yarn add mdvc
+```
+
+## Usage
+
+```js
+
+import { createApp, defineAsyncComponent } from 'vue'
+import mdvc from 'mdvc';
+
+const files = {
+    'main.md': `
+
+## Hello World!
+
+\`\`\`js
+console.log(123)
+\`\`\`
+
+<h1>{{ msg }}</h1>
+<button @click="msg = msg.split('').reverse().join('')">
+    Reverse
+</button>
+
+<script setup>
+import './main.css'
+import { ref } from 'vue'
+const msg = ref("Hello World!")
+</script>
+
+<style scoped>
+h1 {
+    color: red;
+}
+</style>`,
+
+    'main.css': `
+
+@import url('./files/part.css') screen and (min-width: 500px);
+h1 {
+    text-decoration: underline;
+}`,
+    'files/part.css': `
+
+h1 {
+    text-align: center;
+}`
+
+}
+
+createApp(defineAsyncComponent(() => mdvc('main.md', { files }))).mount('#app')
+
+```
+
+## Definiton
+
+```ts
+import { Component } from 'vue'
+import { File } from 'vue-sfc-component';
+
+type MaybePromise<T> = T | Promise<T>
+type FileContent = string | ArrayBuffer | Blob | Response
+
+export default async function(
+    mainfile: string,
+    options?: {
+        imports?: Record<string, any>;
+        files?: Record<string, FileContent | URL>;
+        getFile?: (path: string) => MaybePromise<FileContent | URL>;
+        renderStyles?: (css: string) => MaybePromise<string>;
+        catch?: (errors: Array<string | Error>) => MaybePromise<void>;
+        fileConvertRule?: (file: File) => MaybePromise<void>;
+        markdown?: Markdown.Options;
+        extend?: (md: Markdown) => void;
+    }
+) : Promise<Component>
+```
+
+## Options
+
+### 1. `markdown`
+
+`markdown-it` options
+
+### 2. `extend`
+
+You can extend `markdown-it` by passing a function to `extend` option.
+
+```js
+import mdvc from 'mdvc';
+import katex from 'markdown-it-katex'
+
+mdvc('main.md', {
+    extend(md) {
+        md.use(katex)
+    },
+    // ...
+})
+```
+
+Other options are the same as [vue-sfc-component](https://github.com/YouXam/vue-sfc-component) options.
+
+## License
+
+[MIT](LICENSE)

package.json

@@ -0,0 +1,31 @@
+{
+  "name": "mdvc",
+  "version": "0.0.1",
+  "description": "Convert markdown-vue files to vue components.",
+  "main": "dist/src/index.js",
+  "scripts": {
+    "dev": "vite dev --open test/index.html",
+    "build": "tsc"
+  },
+  "author": "YouXam",
+  "license": "MIT",
+  "type": "module",
+  "files": [
+    "dist/"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/YouXam/mdvc.git"
+  },
+  "devDependencies": {
+    "@types/markdown-it": "^13.0.7",
+    "@vitejs/plugin-vue": "^5.0.3",
+    "typescript": "^5.3.3",
+    "vite": "^5.0.12",
+    "vue": "^3.4.15"
+  },
+  "dependencies": {
+    "markdown-it": "^14.0.0",
+    "vue-sfc-component": "^0.0.7"
+  }
+}