🤗 One-stop solution for vue component documentation. Original org: https://github.com/vuese

vuese

Last update: Jan 1, 2023

Related tags

Docs vuese

Overview

vuese

One-stop solution for vue component documentation

This project is supported by our Backers

Document

For detailed documentation: vuese.org

Overview

Vuese Automatically generate documentation for your vue component, and provides a variety of solutions for generating component documentation to meet your different needs.

@vuese/cli

@vuese/cli is a command line tool that is very simple to use. If you want to quickly build a documentation site for your vue component or just want to generate markdown document for your vue component, then this tool might be a good choice. Please go to the details: @vuese/cli

@vuese/parser

The @vuese/parser module is the parser for the vue component, @vuese/cli internally parsing the vue component via the @vuese/parser module and extract the information we want. You can do any more advanced things with the interface provided by the @vuese/parser module. For the API documentation, please go to @vuese/parser

Online experience

Visit the following 👇 link to intuitively feel @vuese/parser:

An online experience playground for vuese

@vuese/markdown-render

@vuese/markdown-render receives the result of the Vue file parsed by @vuese/parser as a parameter, generate a markdown string. @vuese/markdown-render is also used for @vuese/cli's document generation, in other words, you can use @vuese/markdown-render and @vuese/parser alone to write your own CLI tool to do something interesting.

@vuese/loader

@vuese/cli is a tool for quickly creating document prototypes that don't have a more flexible documentation solution. So this is why @vuese/loader and @vuese/webpack-plugin are needed.

Our goal is to focus only on the parts that can be automated, and does not limit how your document project is organized and what document framework is used. Of course, we can also provide fast solutions.

[WIP][todo]

@vuese/webpack-plugin

[WIP][todo]

Roadmap

Planning for vuese2.x: Read our roadmap

Contributing

Fork it!
Create your feature branch: git checkout -b my-new-feature
Commit your changes: yarn commit
Push to the branch: git push origin my-new-feature
Submit a pull request :D

Developer Resources

Running a Local Build

In root directory of your Vuese project:

Run yarn run build
Run yarn link

In project that you want to use the libaries:

If @vuese/cli is not yet installed, add it: yarn add @vuese/cli
Run yarn link vuese-monorepo
Navigate to node_modules/.bin and open vuese.cmd and vuese
Change any instance of @vuese to vuese-monorepo\packages in both files

To generate the documentation locally, run the vuese binary from node_modules/.bin :

Run node_modules\.bin\vuese gen (cmd) or
Run node_modules/.bin/vuese gen (powershell)

Samples

Component Notation

Component Documentation

Samples/Docs Folder

Get started immediately in a free online dev environment:

Contributors

Thanks goes to these wonderful people:

_HcySunYang 💻 ⚠️ 📖 💡	_{Barthélémy Ledoux} 🐛 💻	_{Bernhard Wittmann} 💻 🤔	_{Steve Young} 🐛 💻	_wulunyi 💻	_Estelle00 💻	_{Matt Roxburgh} 🐛 💻
_{James George} 💻 📖	_{IWANABETHATGUY} 💻 ⚠️ 📖 🐛	_screetBloom 💻 ⚠️ 📖 🐛 🚇	_{Michele Girini} ⚠️ 🐛 💻

Author

Vuese © HcySunYang, Released under the MIT License.
Authored and maintained by HcySunYang.

homepage · GitHub @HcySunYang · Twitter @HcySunYang

Comments

Eslint and vuese default properties

Describe the bug The default declaration to an array property in Eslint is default () { return [] } like they describe in this link https://github.com/vuejs/eslint-plugin-vue/blob/master/docs/rules/require-valid-default-prop.md, but when i use vuese my output is the below because vuese search for default: []

Vuese output pictures

opened by VitoriaFaria 13

Typescript still not working

Describe the bug Typescript still not working

To Reproduce Using just the parser, I ran the following:

const { parser } = require('@vuese/parser')

// Read vue file content
const source = `
<template>
  <div>
    <button @click="clicked">click</button>
    <br>
    {{x}}
  </div>
</template>

<script lang="ts">
  import { Component, Prop, Vue } from 'vue-property-decorator'

  @Component
  export default class ModulesDemo extends Vue {

    @Prop() x :string

    clicked() {
      this.x = new Date().toString()
    }
  }
</script>

<style scoped>

</style>

  
`
// Parse and get the result using the parser function
try {
  console.log(source)
  const parserRes = parser(source)
  console.log(parserRes)
} catch(e) {
  console.error(e)
}

Expected behavior Expected to see something in parserRes object. Instead parserRes was empty:

{ componentDesc: { default: [] } }

Screenshots not applicable

Which version do you use: 1.4.7

Additional information none

enhancement feature request

opened by davidmoshal 12

Windows下面运行gen直接NPM报错退出

0 info it worked if it ends with ok 1 verbose cli [ 'd:\Program Files\nodejs\node.exe', 1 verbose cli 'd:\Program Files\nodejs\node_modules\npm\bin\npm-cli.js', 1 verbose cli 'run', 1 verbose cli 'gen' ] 2 info using [email protected] 3 info using [email protected] 4 verbose run-script [ 'pregen', 'gen', 'postgen' ]

13 verbose stack Error: [email protected] gen: vuese gen --include="app/web/**/*.vue" 13 verbose stack Exit status 1 13 verbose stack at EventEmitter. (C:\Users\H004335.WTOIP\AppData\Roaming\nvm\v8.11.3\node_modules\npm\node_modules\npm-lifecycle\index.js:285:16) 13 verbose stack at emitTwo (events.js:126:13) 13 verbose stack at EventEmitter.emit (events.js:214:7) 13 verbose stack at ChildProcess. (C:\Users\H004335.WTOIP\AppData\Roaming\nvm\v8.11.3\node_modules\npm\node_modules\npm-lifecycle\lib\spawn.js:55:14) 13 verbose stack at emitTwo (events.js:126:13) 13 verbose stack at ChildProcess.emit (events.js:214:7) 13 verbose stack at maybeClose (internal/child_process.js:925:16) 13 verbose stack at Process.ChildProcess._handle.onexit (internal/child_process.js:209:5)

opened by a526672351 11

Cannot generate Docute document (error message)

Hello,

Thanks for this interesting project. I have tried to set up a Docute document, but I'm failing using the gen command every time using vuese gen --include="src/pages/search/*.vue".

The error reads

⏳  Start creating markdown files...
TypeError: Cannot read property 'children' of undefined
    at Object.comment (/usr/local/share/.config/yarn/global/node_modules/vue-template-compiler/build.js:2575:21)
    at parseHTML (/usr/local/share/.config/yarn/global/node_modules/vue-template-compiler/build.js:345:23)
    at parse (/usr/local/share/.config/yarn/global/node_modules/vue-template-compiler/build.js:2402:3)
    at baseCompile (/usr/local/share/.config/yarn/global/node_modules/vue-template-compiler/build.js:4267:13)
    at Object.compile (/usr/local/share/.config/yarn/global/node_modules/vue-template-compiler/build.js:4242:22)
    at sfcToAST (/usr/local/share/.config/yarn/global/node_modules/vuese/dist/vuese.js:28:47)
    at parser$1 (/usr/local/share/.config/yarn/global/node_modules/vuese/dist/vuese.js:402:20)
    at files.map (/usr/local/share/.config/yarn/global/node_modules/vuese/lib/index.js:30:23)
    at <anonymous>

Anyone knows why this happens?

Also, I'd like to know if the command parses all subdirectories automatically?

Thank you in advance

opened by arjanski 11

Add support for mixins

Adds the ability for Vuese to be used with mixins. Mixins are still not picked up automatically so this functionality is completely optional. Adding **/*.js to the included will allow these to be picked up.

Let me know if you see something you would like changed.

Thanks!

(This PR was made in place of #103, because a lot has changed and to keep git history clean)

opened by TayHobbs 9
Keep Folder Structure
Hi,

wondering if there is an option to keep the folder structure of files when exporting to markdown in a new directory:

components/ - forms/ MyForm.vue - nav/ LeNav.vue

resulting in:

components/ - forms/ MyForm.md - nav/ LeNav.md

.. instead of a flat list of Markdown files. this would be very useful for automated postprocessing in other markdown tools. Maybe there should be an option to use the "group" annotation for a new folder structure.

What do you think?

Cheers, Rainer
feature request cli
opened by rainerCH 9
Enhancement request - document Computed properties when flagged using // @vuese

When generating MixIns then computed properties are important to know about.

Also useful when documenting components for internal use.

I have created a pull request with this feature implemented. Compute docs #58
enhancement has PR

opened by roxburghm 8

Typescript support?

Wondering if this plugin can parse .vue files with typescript, classes, and less styles?

e.g:

<template>
  <div>
    demo
  </div>
</template>

<script 
  lang="ts">

  import { Component, Vue } from 'vue-property-decorator';

  @Component
  export default class Demo extends Vue{
  
  }
</script>

<style 
   lang="less" 
   scoped>

</style>

Want to achieve

opened by davidmoshal 8

Add ability to create docs for store.js and .js files.

This PR adds the ability for Vuese to be used with the store.js file and any mixins. I didn't set these to be automatically included, so this functionality would be completely optional. Adding **/*.js to the included will allow these to be picked up.

I am not too familiar with TypeScript, so if there a better way to accomplish any of this, or if you see anything you would like changed, let me know and I will update this PR.

Thanks!

opened by TayHobbs 7
404 error when outDir is used with different path
Describe the bug When you use a different output folder via Outdir="/some/folder/path" then it will not find the html file when you try to open the docs. It just shows 404 The requested Path could not be found.

To Reproduce Steps to reproduce the behavior:

vuese gen outDir='resources/docs/1.0/vuese'

vuese serve --open

Expected behavior Open the documentation

Which version do you use: 1.4.7
opened by janiskelemen 7
Config has no effect on generate

Hi,

nice tool! However, I cannot seem to get the config file to work. No matter what I type in there as include value it always loads all .vue files from my project root. Even if I directly enter an include option like vuese gen --include="assets/js/components//*.vue"** it just seems to ignore the given path.

Best regards Janis

opened by janiskelemen 7
build(deps): bump json5 from 2.1.0 to 2.2.3
Bumps json5 from 2.1.0 to 2.2.3.

Release notes

Sourced from json5's releases.

v2.2.3

Fix: [email protected] is now the 'latest' release according to npm instead of v1.0.2. (#299)

v2.2.2

Fix: Properties with the name __proto__ are added to objects and arrays. (#199) This also fixes a prototype pollution vulnerability reported by Jonathan Gregson! (#295).

v2.2.1

Fix: Removed dependence on minimist to patch CVE-2021-44906. (#266)

v2.2.0

New: Accurate and documented TypeScript declarations are now included. There is no need to install @types/json5. (#236, #244)

v2.1.3 [code, diff]

Fix: An out of memory bug when parsing numbers has been fixed. (#228, #229)

v2.1.2

Fix: Bump minimist to v1.2.5. (#222)

v2.1.1

New: package.json and package.json5 include a module property so bundlers like webpack, rollup and parcel can take advantage of the ES Module build. (#208)

Fix: stringify outputs \0 as \\x00 when followed by a digit. (#210)

Fix: Spelling mistakes have been fixed. (#196)

Changelog

Sourced from json5's changelog.

v2.2.3 [code, diff]

Fix: [email protected] is now the 'latest' release according to npm instead of v1.0.2. (#299)

v2.2.2 [code, diff]

Fix: Properties with the name __proto__ are added to objects and arrays. (#199) This also fixes a prototype pollution vulnerability reported by Jonathan Gregson! (#295).

v2.2.1 [code, diff]

Fix: Removed dependence on minimist to patch CVE-2021-44906. (#266)

v2.2.0 [code, diff]

New: Accurate and documented TypeScript declarations are now included. There is no need to install @types/json5. (#236, #244)

v2.1.3 [code, diff]

Fix: An out of memory bug when parsing numbers has been fixed. (#228, #229)

v2.1.2 [code, diff]

Fix: Bump minimist to v1.2.5. (#222)

v2.1.1 [code, [diff][d2.1.1]]

... (truncated)

Commits

c3a7524 2.2.3

94fd06d docs: update CHANGELOG for v2.2.3

3b8cebf docs(security): use GitHub security advisories

f0fd9e1 docs: publish a security policy

6a91a05 docs(template): bug -> bug report

14f8cb1 2.2.2

10cc7ca docs: update CHANGELOG for v2.2.2

7774c10 fix: add proto to objects and arrays

edde30a Readme: slight tweak to intro

97286f8 Improve example in readme

Additional commits viewable in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

@dependabot rebase will rebase this PR

@dependabot recreate will recreate this PR, overwriting any edits that have been made to it

@dependabot merge will merge this PR after your CI passes on it

@dependabot squash and merge will squash and merge this PR after your CI passes on it

@dependabot cancel merge will cancel a previously requested merge and block automerging

@dependabot reopen will reopen this PR if it is closed

@dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually

@dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

@dependabot use these labels will set the current labels as the default for future PRs for this repo and language

@dependabot use these reviewers will set the current reviewers as the default for future PRs for this repo and language

@dependabot use these assignees will set the current assignees as the default for future PRs for this repo and language

@dependabot use this milestone will set the current milestone as the default for future PRs for this repo and language

You can disable automated security fix PRs for this repo from the Security Alerts page.

dependencies
opened by dependabot[bot] 0
build(deps): bump qs from 6.5.2 to 6.5.3
Bumps qs from 6.5.2 to 6.5.3.

Changelog

Sourced from qs's changelog.

6.5.3

[Fix] parse: ignore __proto__ keys (#428)

[Fix] utils.merge: avoid a crash with a null target and a truthy non-array source

[Fix] correctly parse nested arrays

[Fix] stringify: fix a crash with strictNullHandling and a custom filter/serializeDate (#279)

[Fix] utils: merge: fix crash when source is a truthy primitive & no options are provided

[Fix] when parseArrays is false, properly handle keys ending in []

[Fix] fix for an impossible situation: when the formatter is called with a non-string value

[Fix] utils.merge: avoid a crash with a null target and an array source

[Refactor] utils: reduce observable [[Get]]s

[Refactor] use cached Array.isArray

[Refactor] stringify: Avoid arr = arr.concat(...), push to the existing instance (#269)

[Refactor] parse: only need to reassign the var once

[Robustness] stringify: avoid relying on a global undefined (#427)

[readme] remove travis badge; add github actions/codecov badges; update URLs

[Docs] Clean up license text so it’s properly detected as BSD-3-Clause

[Docs] Clarify the need for "arrayLimit" option

[meta] fix README.md (#399)

[meta] add FUNDING.yml

[actions] backport actions from main

[Tests] always use String(x) over x.toString()

[Tests] remove nonexistent tape option

[Dev Deps] backport from main

Commits

298bfa5 v6.5.3

ed0f5dc [Fix] parse: ignore __proto__ keys (#428)

691e739 [Robustness] stringify: avoid relying on a global undefined (#427)

1072d57 [readme] remove travis badge; add github actions/codecov badges; update URLs

12ac1c4 [meta] fix README.md (#399)

0338716 [actions] backport actions from main

5639c20 Clean up license text so it’s properly detected as BSD-3-Clause

51b8a0b add FUNDING.yml

45f6759 [Fix] fix for an impossible situation: when the formatter is called with a no...

f814a7f [Dev Deps] backport from main

Additional commits viewable in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

@dependabot rebase will rebase this PR

@dependabot recreate will recreate this PR, overwriting any edits that have been made to it

@dependabot merge will merge this PR after your CI passes on it

@dependabot squash and merge will squash and merge this PR after your CI passes on it

@dependabot cancel merge will cancel a previously requested merge and block automerging

@dependabot reopen will reopen this PR if it is closed

@dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually

@dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

@dependabot use these labels will set the current labels as the default for future PRs for this repo and language

@dependabot use these reviewers will set the current reviewers as the default for future PRs for this repo and language

@dependabot use these assignees will set the current assignees as the default for future PRs for this repo and language

@dependabot use this milestone will set the current milestone as the default for future PRs for this repo and language

You can disable automated security fix PRs for this repo from the Security Alerts page.

dependencies
opened by dependabot[bot] 0
build(deps): bump decode-uri-component from 0.2.0 to 0.2.2
Bumps decode-uri-component from 0.2.0 to 0.2.2.

Release notes

Sourced from decode-uri-component's releases.

v0.2.2

Prevent overwriting previously decoded tokens 980e0bf

https://github.com/SamVerschueren/decode-uri-component/compare/v0.2.1...v0.2.2

v0.2.1

Switch to GitHub workflows 76abc93

Fix issue where decode throws - fixes #6 746ca5d

Update license (#1) 486d7e2

Tidelift tasks a650457

Meta tweaks 66e1c28

https://github.com/SamVerschueren/decode-uri-component/compare/v0.2.0...v0.2.1

Commits

a0eea46 0.2.2

980e0bf Prevent overwriting previously decoded tokens

3c8a373 0.2.1

76abc93 Switch to GitHub workflows

746ca5d Fix issue where decode throws - fixes #6

486d7e2 Update license (#1)

a650457 Tidelift tasks

66e1c28 Meta tweaks

See full diff in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

@dependabot rebase will rebase this PR

@dependabot recreate will recreate this PR, overwriting any edits that have been made to it

@dependabot merge will merge this PR after your CI passes on it

@dependabot squash and merge will squash and merge this PR after your CI passes on it

@dependabot cancel merge will cancel a previously requested merge and block automerging

@dependabot reopen will reopen this PR if it is closed

@dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually

@dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

@dependabot use these labels will set the current labels as the default for future PRs for this repo and language

@dependabot use these reviewers will set the current reviewers as the default for future PRs for this repo and language

@dependabot use these assignees will set the current assignees as the default for future PRs for this repo and language

@dependabot use this milestone will set the current milestone as the default for future PRs for this repo and language

You can disable automated security fix PRs for this repo from the Security Alerts page.

dependencies
opened by dependabot[bot] 0
Props not read when using defineComponent
Describe the bug When I use defineComponent, Vuese does not extract props.

To Reproduce You can see it in the sandbox: https://vuese.github.io/vuese-explorer/

First, try it without defineComponent:

<template> <div /> </template> <script> export default { name: 'MyComponent', props: { // Loading loading: { type: Boolean, }, }, }; </script>

This will output a props section with the loading prop, its type and the comment above it.

Then with:

<template> <div /> </template> <script> import {defineComponent} from 'vue'; export default defineComponent({ name: 'MyComponent', props: { // Loading loading: { type: Boolean, }, }, }); </script>

This will output nothing.

Expected behavior Props to show up in the example where I use defineComponent, just as they do in the one without it.
opened by EdieLemoine 0
SpreadElement in Props Object doesn't extract success
Describe the bug SpreadElement in Props Object doesn't extract success.

To Reproduce Steps to reproduce the behavior:

use props object with SpreadElement

vuese/parser parse vue sfc

Expected behavior SpreadElement Object in props can parse success

Screenshots

use vuese/parser. cannot extract commonProps

Environmental information: For convenience, you can get environmental information by executing the vuese info command.

Additional information Add any other information about the problem here.
opened by jy0529 2

Owner

vuese

One-stop solution for vue component documentation

GitHub https://vuese.org/

📇 Convert Markdown file to Vue component.

You have other better choices https://github.com/egoist/vmark https://github.com/liril-net/ware-loader vue-markdown-loader Convert Markdown file to Vu

703 Nov 30, 2022

React inspired style guide generator for Vue.js

?? [20/09/2017] Project discontinued ?? For purpose of having a demo of your Vuejs components please take a look at following projects that do really

123 Jul 30, 2020

Created from react styleguidist for Vue Components with a living style guide

Isolated Vue component development environment with a living style guide Start documenting now on codesandbox.io Sponsors A big thank you to our spons

2.3k Dec 28, 2022

A library for documenting Vue components

Elucidate A library that makes it a breeze to "shed light" on your Vue component. Demo: https://mattrothenberg.github.io/vue-elucidate-example Demo Vi

34 Dec 6, 2022

:sparkles: Markdown files to ALIVE Vue components.

vue-md-loader Introduction Webpack loader for converting Markdown files to ALIVE Vue components. Configurable Markdown-It parser. Built-in syntax high

111 Nov 20, 2022

A simple plugin for jsdoc (`pase vue SFC info to description`)

jsdoc-vue-component A simple plugin for jsdoc (pase vue SFC info to description by AST analysis). Maybe you will try jsdoc-vuedoc, and you have a bett

11 May 7, 2022

Custom story blocks for Vue single file components

vue-storybook Custom <story> blocks for Vue single file components that work out of the box with Vue CLI 3 and vue-cli-plugin-storybook. yarn add vue-

151 Aug 3, 2022

Easily build beautiful tutorials with Vue

VueTut Easily build beautiful tutorials with Vue. ?? ⠀Docs ?? ⠀Tutorial/Demo Install npm i vue-tut Setup import VueTut from 'vue-tut'; import 'vue-tut

45 Dec 24, 2022

A webpack loader for markdown file transform to vue file.

vue-dotmd-loader A webpack loader for loader markdown file transform to vue file. 中文 Features： Support to import Vue file components and render them i

10 May 18, 2022

Vue's template compiler reimplemented in Rust!

Vue Compiler in Rust Try it out in the wasm playground! Evan says: Maybe in the long run we want the whole transform (and even the Vue compiler!) to b

686 Jan 3, 2023

A vue router storage solution. -If your vue application needs to jump to a third party page, and then jump back, want to restore to the original history and continue to operate, the use of this plug-in is the best solution.如果你的vue应用需要跳转到第三方页面，再跳转回来时，想恢复到原来的历史记录并继续操作，使用本插件是最好的解决方案。

vue-router-storage A solution to the Vue history routing Persistence. 中文文档 Warn：Current Version Just Support The History Mode! Current function Persis

96 Nov 3, 2022

vuejs and Django integration with hot code reload. Dont use this, use https://github.com/NdagiStanley/vue-django or https://github.com/gtalarico/django-vue-template

hello-vue + Django This is a boilerplate project for using vuejs with Django. Features Django backend in ./backend vuejs (v2) frontend in ./frontend H

329 Dec 8, 2022

Filscan browser is the filecoin blockchain browser and data service platform，It provides one-stop data services such as mining ranking, blockchain data query and visualization chart based on filecoin

Filscan browser is the filecoin blockchain browser and data service platform，It provides one-stop data services such as mining ranking, blockchain data query and visualization chart based on filecoin

9 Jun 2, 2022

A Vue.js (https://github.com/vuejs/vue) plugin that offers a reusable directive to get image from Cloudinary (https://cloudinary.com)

vue-cloudinary A Vue.js plugin that offers a reusable directive to get image from cloudinary Overview This is a port of the angular-cloudinary library

25 Dec 5, 2020

Generate a Markdown Documentation for a SFC Vue Component. Contribute: https://gitlab.com/vuedoc/md#contribute

Vuedoc Markdown Documentation Generator Generate a Markdown Documentation for a Vue file Table of Contents Install Features Command line usage Command

158 Nov 24, 2022

Generate a JSON documentation for a SFC Vue component. Contribute: https://gitlab.com/vuedoc/parser#contribute

The Vuedoc Parser Generate a JSON documentation for a Vue file component. Table of Contents Install Features Options Usage Syntax Add component name A

86 Nov 15, 2022

MEVN Full Stack E-Commerce Solution. Built using MEVN Stack (Node.js, Express.js, Vue.js, MongoDB) with Developer Friendliness and Cloud Integrations in mind. Previously Powered the Veniqa New York Startup. 100% Customizable. For Demos and Documentation, Visit Official Website

Open-source E-commerce Solution. Built using MEVN Stack (Node.js, Express.js, Vue.js, MongoDB) with Developer Friendliness and Cloud Integrations in m

1k Jan 2, 2023

🤗 One-stop solution for vue component documentation. Original org: https://github.com/vuese

Related tags

Overview

vuese

Document

Overview

@vuese/cli

@vuese/parser

Online experience

@vuese/markdown-render

@vuese/loader

@vuese/webpack-plugin

Roadmap

Contributing

Developer Resources

Component Notation

Component Documentation

Contributors

Author

Comments

v2.2.3

v2.2.2

v2.2.1

v2.2.0

v2.1.3 [code, diff]

v2.1.2

v2.1.1

v2.2.3 [code, diff]

v2.2.2 [code, diff]

v2.2.1 [code, diff]

v2.2.0 [code, diff]

v2.1.3 [code, diff]

v2.1.2 [code, diff]

v2.1.1 [code, [diff][d2.1.1]]

6.5.3

v0.2.2

v0.2.1

Owner

vuese

📇 Convert Markdown file to Vue component.

React inspired style guide generator for Vue.js

Created from react styleguidist for Vue Components with a living style guide

A library for documenting Vue components

:sparkles: Markdown files to ALIVE Vue components.

A simple plugin for jsdoc (`pase vue SFC info to description`)

Custom story blocks for Vue single file components

Easily build beautiful tutorials with Vue

A webpack loader for markdown file transform to vue file.

Vue's template compiler reimplemented in Rust!

vuejs and Django integration with hot code reload. Dont use this, use https://github.com/NdagiStanley/vue-django or https://github.com/gtalarico/django-vue-template

Filscan browser is the filecoin blockchain browser and data service platform，It provides one-stop data services such as mining ranking, blockchain data query and visualization chart based on filecoin

A Vue.js (https://github.com/vuejs/vue) plugin that offers a reusable directive to get image from Cloudinary (https://cloudinary.com)

Generate a Markdown Documentation for a SFC Vue Component. Contribute: https://gitlab.com/vuedoc/md#contribute

Generate a JSON documentation for a SFC Vue component. Contribute: https://gitlab.com/vuedoc/parser#contribute

MEVN Full Stack E-Commerce Solution. Built using MEVN Stack (Node.js, Express.js, Vue.js, MongoDB) with Developer Friendliness and Cloud Integrations in mind. Previously Powered the Veniqa New York Startup. 100% Customizable. For Demos and Documentation, Visit Official Website

▶️ 🎹 🎵 HTML5 audio tag sound player UI for Vue.js - supports single, loop, pause/stop modes etc

A tiny Vue directive that stop propagation scroll when edge reached

KOKK - a tool that fetches a Markdown file and renders it as a beautiful one-page documentation.