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

Related tags

vuese
Overview

vuese

One-stop solution for vue component documentation

This project is supported by our Backers

build status License PRs Welcome Commitizen friendly Code style Support me

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

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

Developer Resources

Running a Local Build

In root directory of your Vuese project:

  1. Run yarn run build
  2. Run yarn link

In project that you want to use the libaries:

  1. If @vuese/cli is not yet installed, add it: yarn add @vuese/cli
  2. Run yarn link vuese-monorepo
  3. Navigate to node_modules/.bin and open vuese.cmd and vuese
  4. 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 :

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

Samples

Component Notation

  1. Samples/Components Folder
  2. Vuese Explorer

Component Documentation

  1. Samples/Docs Folder

Get started immediately in a free online dev environment:

Open in Gitpod

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

Issues
  • Eslint and vuese default properties

    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

    Screenshot_2019-05-21 TraysCard - Components

    opened by VitoriaFaria 13
  • Typescript still not working

    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报错退出

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

    image

    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)

    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
  • Keep Folder Structure

    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

    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?

    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 <mixin>.js files.

    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

    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:

    1. vuese gen outDir='resources/docs/1.0/vuese'
    2. 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

    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
  • Adaptation for Nuxt

    Adaptation for Nuxt

    Is an adaptation of the module for Nuxt planned ?

    opened by JuBertowinwin 0
  • build(deps): bump tmpl from 1.0.4 to 1.0.5

    build(deps): bump tmpl from 1.0.4 to 1.0.5

    Bumps tmpl from 1.0.4 to 1.0.5.

    Commits

    Dependabot compatibility score

    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 prismjs from 1.24.0 to 1.25.0

    build(deps): bump prismjs from 1.24.0 to 1.25.0

    Bumps prismjs from 1.24.0 to 1.25.0.

    Release notes

    Sourced from prismjs's releases.

    v1.25.0

    Release 1.25.0

    v1.24.1

    Release 1.24.1

    Changelog

    Sourced from prismjs's changelog.

    1.25.0 (2021-09-16)

    New components

    Updated components

    ... (truncated)

    Commits

    Dependabot compatibility score

    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
  • name 解析错误

    name 解析错误

    当js内存在 name字段的json就会解析错误 iShot2021-09-02 21 15 39

    opened by suasong 1
  • build(deps): bump path-parse from 1.0.6 to 1.0.7

    build(deps): bump path-parse from 1.0.6 to 1.0.7

    Bumps path-parse from 1.0.6 to 1.0.7.

    Commits

    Dependabot compatibility score

    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
  • Using @group causes 404 on load

    Using @group causes 404 on load

    Describe the bug When I specify @group on components, the components are successfully split in the left nav, but the initial page that loads on vuese serve --open becomes:

    Server running at http://127.0.0.1:5000/#undefined
    

    Even if I am able to get a valid path opened, if I click on the "Components" header to return me to the index (e.g., http://127.0.0.1:5000/#) I still get the following in the browser in the right pane of the page:

    404 The requested path could not be found

    Note that if I click on any of the component items themselves that the correct markup loads and renders. But that initial load, or if the Components header is clicked, results in a 404.

    To Reproduce Steps to reproduce the behavior:

    1. In your Vue component descriptor, add @group Controls to any component. I was able to reproduce this with any control, whether it was first alphabetically or not. I also tried adding a group to all controls with the same result.
    2. Generate the docs with vuese gen
    3. Open the docs with vuese serve --open

    Note that steps 2 and 3 were performed using npm with those scripts defined in the package.json.

    Expected behavior Either first component is opened in the browser, with any clicks on the Components header also redirecting to that component.

    Or an index page can be defined in some way to be used as the Overview for the docs.

    Screenshots Screen Shot 2021-06-29 at 3 36 19 PM

    Environmental information: System: OS: macOS 11.4 CPU: (16) x64 Intel(R) Core(TM) i9-9880H CPU @ 2.30GHz Binaries: Node: 14.4.0 - ~/.nvm/versions/node/v14.4.0/bin/node npm: 6.14.5 - ~/.nvm/versions/node/v14.4.0/bin/npm Browsers: Chrome: 91.0.4472.114 Firefox: 88.0.1 Safari: 14.1.1

    opened by rocket-tyard 1
  • build(deps): bump ws from 5.2.2 to 5.2.3

    build(deps): bump ws from 5.2.2 to 5.2.3

    Bumps ws from 5.2.2 to 5.2.3.

    Release notes

    Sourced from ws's releases.

    5.2.3

    Bug fixes

    • Backported 00c425ec to the 5.x release line (76d47c14).
    Commits

    Dependabot compatibility score

    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 tar from 2.2.1 to 2.2.2

    build(deps): bump tar from 2.2.1 to 2.2.2

    Bumps tar from 2.2.1 to 2.2.2.

    Commits
    • 523c5c7 2.2.2
    • 7ecef07 Bump fstream to fix hardlink overwriting vulnerability
    • 9fc84b9 Use {} for hardlink tracking instead of []
    • 15e59f1 Only track previously seen hardlinks
    • 4f85851 Ignore potentially unsafe files
    • See full diff in compare view

    Dependabot compatibility score

    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 acorn from 5.7.3 to 5.7.4

    build(deps): bump acorn from 5.7.3 to 5.7.4

    Bumps acorn from 5.7.3 to 5.7.4.

    Commits

    Dependabot compatibility score

    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 set-getter from 0.1.0 to 0.1.1

    build(deps): bump set-getter from 0.1.0 to 0.1.1

    Bumps set-getter from 0.1.0 to 0.1.1.

    Commits

    Dependabot compatibility score

    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
Owner
vuese
One-stop solution for vue component documentation
vuese
NightWriter is a modern real-time collaborative editing tool secured by end-to-end encryption.

After many years of searching for a good document tool that is simple, secure and modern, I decided to develop it. NightWriter offers simple, secured by end-to-end encryption and real-time collaborative editing.

Titanex 8 Oct 16, 2021
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

Mikhail Kuznetcov 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

Vue Styleguidist 2.1k Oct 14, 2021
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

Electron Vue Window Toolkit 42 Jul 10, 2021
: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

wxsm 85 Oct 9, 2021
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

Matt Rothenberg 35 Aug 25, 2020
📇 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

cinwell.li 686 Oct 12, 2021
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

蓝月萧枫 5 Sep 29, 2021
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

Season Chen 11 Sep 23, 2021
A jsdoc3 plugin use `@vuedoc/md`

jsdoc-vuedoc A jsdoc plugin use @vuedoc/md. Dependencies [email protected]: That support async/await features. @vuedoc/md. Installation npm i jsdoc-vuedoc -D o

Season Chen 18 Oct 14, 2021
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-

Matt Rothenberg 1.3k Oct 17, 2021