diff --git a/doc/components/DiagramDemo.vue b/doc/components/DiagramDemo.vue deleted file mode 100644 index 169e653..0000000 --- a/doc/components/DiagramDemo.vue +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - - diff --git a/doc/components/Header.vue b/doc/components/Header.vue deleted file mode 100644 index 463939b..0000000 --- a/doc/components/Header.vue +++ /dev/null @@ -1,57 +0,0 @@ - - - - - Vue-diagrams - Guides - StoryBook - - - - - - - - - - - diff --git a/doc/components/Repl.vue b/doc/components/Repl.vue deleted file mode 100644 index de6779d..0000000 --- a/doc/components/Repl.vue +++ /dev/null @@ -1,111 +0,0 @@ - - - - - - - diff --git a/doc/examples/index.ts b/doc/examples/index.ts index 61b583e..fb45a85 100644 --- a/doc/examples/index.ts +++ b/doc/examples/index.ts @@ -19,7 +19,6 @@ type ExampleImports = { [key: string]: any; } - export const exampleImports: Record = { playground, shader, diff --git a/doc/examples/playground/index.ts b/doc/examples/playground/index.ts index d095683..f039c1d 100644 --- a/doc/examples/playground/index.ts +++ b/doc/examples/playground/index.ts @@ -1,4 +1,4 @@ -import PlaygroundApp from './App.vue?raw' +import PlaygroundApp from './App.vue?raw'; export default { section: 'Demo', diff --git a/doc/examples/serializationDeserialization/App.vue b/doc/examples/serializationDeserialization/App.vue index 7deff63..58f5f3b 100644 --- a/doc/examples/serializationDeserialization/App.vue +++ b/doc/examples/serializationDeserialization/App.vue @@ -1,7 +1,7 @@ - serialize deserialize + - diff --git a/doc/nuxt.config.js b/doc/nuxt.config.js index 87e191b..2e6e300 100644 --- a/doc/nuxt.config.js +++ b/doc/nuxt.config.js @@ -1,4 +1,8 @@ + export default { + modules: [ + 'nuxt-quickdoc', + ], target: 'static', ssr: false, }; diff --git a/doc/package.json b/doc/package.json index 6d40aa3..d0b0ba5 100644 --- a/doc/package.json +++ b/doc/package.json @@ -18,6 +18,7 @@ "@mdi/font": "^7.1.96", "@vue/repl": "^3.0.0", "codemirror": "^6.0.1", + "nuxt-quickdoc": "https://github.com/gwenaelp/nuxt-quickdoc.git", "vue-codemirror": "^6.1.1", "vue3-carousel": "^0.3.1" } diff --git a/doc/pages/index.vue b/doc/pages/index.vue index 4fb356e..f05e14e 100644 --- a/doc/pages/index.vue +++ b/doc/pages/index.vue @@ -1,95 +1,12 @@ - - - - - An easy to use diagram editor component - Diagram component for vue.js, inspired by react-diagrams - For Vue 2 & 3! - - - - - - - Installation - - npm install vue-diagrams - yarn add vue-diagrams - - - - - - Examples - - - - - - - Features - - Easy to learn - - - Grid snap - - - In place editing - Move nodes, resize them, connect links as curves or segments... - - - Serialization/deserialization - - - Various node types - - - - + - - +const examples = [example2, example3]; + + diff --git a/doc/pages/playground.vue b/doc/pages/playground.vue deleted file mode 100644 index e8cca30..0000000 --- a/doc/pages/playground.vue +++ /dev/null @@ -1,73 +0,0 @@ - - - - - {{ name }} - - - - {{ example }} - - - - - - - - - - diff --git a/doc/yarn.lock b/doc/yarn.lock index 34d37e2..d955909 100644 --- a/doc/yarn.lock +++ b/doc/yarn.lock @@ -4236,6 +4236,13 @@ nuxi@^3.10.0: optionalDependencies: fsevents "~2.3.3" +"nuxt-quickdoc@https://github.com/gwenaelp/nuxt-quickdoc.git": + version "1.0.0" + resolved "https://github.com/gwenaelp/nuxt-quickdoc.git#f8c7220fef8541fd5bec50e2bfa36650ea7e693b" + dependencies: + "@nuxt/kit" "^3.8.2" + "@vue/repl" "^3.0.0" + nuxt@^3.8.2: version "3.8.2" resolved "https://registry.yarnpkg.com/nuxt/-/nuxt-3.8.2.tgz#6db515d41e7745c725be7f34f692bdeabc53da07" diff --git a/package.json b/package.json index 2441626..0fe2a22 100644 --- a/package.json +++ b/package.json @@ -1,5 +1,6 @@ { "name": "vue-diagrams", + "title": "An easy to use diagram editor component", "description": "Diagram component for vue.js, inspired by react-diagrams", "type": "module", "version": "1.0.1", @@ -17,12 +18,20 @@ "bugs": { "url": "https://github.com/gwenaelp/vue-diagrams/issues" }, + "examples": [ + "images/example2.png", + "images/example3.png" + ], "homepage": "https://github.com/gwenaelp/vue-diagrams#readme", "keywords": [ "vue", "vue-component", "vue-library" ], + "vueVersions": { + "2": "https://github.com/gwenaelp/vue-diagrams/tree/vue2", + "3": "https://github.com/gwenaelp/vue-diagrams" + }, "engines": { "node": ">=8.9.0" },
Diagram component for vue.js, inspired by react-diagrams
For Vue 2 & 3!
npm install vue-diagrams
yarn add vue-diagrams