Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/vuese/vuese

πŸ€— One-stop solution for vue component documentation. Original org: https://github.com/vuese
https://github.com/vuese/vuese

Last synced: about 1 month ago
JSON representation

πŸ€— One-stop solution for vue component documentation. Original org: https://github.com/vuese

Lists

README 

        
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: [https://vuese.github.io/website/](https://vuese.github.io/website/)



## Overview



[Vuese](https://vuese.github.io/website/) Automatically generate documentation for your `vue` component, and provides a variety of solutions for generating component documentation to meet your different needs.



## @vuese/cli



[![](https://img.shields.io/npm/v/@vuese/cli.svg)](https://www.npmjs.com/package/@vuese/cli)

[![](https://img.shields.io/npm/dm/@vuese/cli.svg)](https://www.npmjs.com/package/@vuese/cli)



[@vuese/cli](https://vuese.github.io/website/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](https://vuese.github.io/website/cli/)



## @vuese/parser



[![](https://img.shields.io/npm/v/@vuese/parser.svg)](https://www.npmjs.com/package/@vuese/parser)

[![](https://img.shields.io/npm/dm/@vuese/parser.svg)](https://www.npmjs.com/package/@vuese/parser)



The [@vuese/parser](https://vuese.github.io/website/parser/) module is the parser for the `vue` component, [@vuese/cli](https://vuese.github.io/website/cli/) internally parsing the `vue` component via the [@vuese/parser](https://vuese.github.io/website/parser/) module and extract the information we want. You can do any more advanced things with the interface provided by the [@vuese/parser](https://vuese.github.io/website/parser/) module. For the `API` documentation, please go to [@vuese/parser](https://vuese.github.io/website/parser/)



### Online experience



Visit the following πŸ‘‡ link to intuitively feel `@vuese/parser`:



[An online experience playground for vuese](https://vuese.github.io/vuese-explorer/)



## @vuese/markdown-render



[![](https://img.shields.io/npm/v/@vuese/markdown-render.svg)](https://www.npmjs.com/package/@vuese/markdown-render)

[![](https://img.shields.io/npm/dm/@vuese/markdown-render.svg)](https://www.npmjs.com/package/@vuese/markdown-render)



[@vuese/markdown-render](https://vuese.github.io/website/markdown-render/) receives the result of the Vue file parsed by [@vuese/parser](https://vuese.github.io/website/parser/) as a parameter, generate a `markdown` string. [@vuese/markdown-render](https://vuese.github.io/website/markdown-render/) is also used for [@vuese/cli](https://vuese.github.io/website/cli/)'s document generation, in other words, you can use [@vuese/markdown-render](https://vuese.github.io/website/markdown-render/) and [@vuese/parser](https://vuese.github.io/website/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](https://github.com/vuese/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 libraries:



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

1. Run `node_modules/.bin/vuese gen` (powershell)






Samples




#### Component Notation



1. [Samples/Components Folder](/samples/components)

2. [Vuese Explorer](https://vuese.github.io/vuese-explorer/)



#### Component Documentation



1. [Samples/Docs Folder](/samples/docs)






Get started immediately in a free online dev environment:



[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/vuese/vuese)



## 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](https://github.com/HcySunYang), Released under the [MIT](./LICENSE) License.


Authored and maintained by HcySunYang.



> [homepage](http://hcysun.me/homepage/) Β· GitHub [@HcySunYang](https://github.com/HcySunYang) Β· Twitter [@HcySunYang](https://twitter.com/HcySunYang)