Git Product home page Git Product logo

vuepress-plugin-component-docgen's Introduction

vuepress-plugin-component-docgen

Vuepress plugin for creating a documentation site of your Vue component

npm

Install from NPM

npm install --save-dev vuepress-plugin-component-docgen

Install from Yarn

yarn add vuepress-plugin-component-docgen

Config for your site

Update your .vuepress/config.js

module.exports = {
    ...
    plugins: [
      [
        'component-docgen',
        {
          rootDir: <string>,
          include: <string | string[]>,
          exclude: <string | string[]>,
          prefix: <string>,
        }
      ]
    ]
}

See Who Is Using component-docgen

Contributors

License

MIT © dacsang97

vuepress-plugin-component-docgen's People

Contributors

dacsang97 avatar

Stargazers

Red Huang avatar Nick Goris avatar zhangwei avatar 唐澜 avatar Loïc Vaillé avatar  avatar Hatice Edis avatar Franck Abgrall avatar Haitao Lee avatar Julien Karst  avatar ULIVZ avatar Nan avatar Barthélémy Ledoux avatar Jörg Bayreuther avatar  avatar

Watchers

James Cloos avatar Hieu Tran avatar  avatar

vuepress-plugin-component-docgen's Issues

We can't use all vue-docgen-api

We can't use all vue-docgen-api when i want to use slot comment emit comment and class description maybe it's a choice ?

next bug

On the preview we should use the prismjs ? or a jsfiddle ?

Maybe it should be another plugin i dont know but it could be nice to couple it with this plugin.

If we would add it it should be when the docs block is parse in src/build/pages/docs.ts or create a mixin or a custom layout we can speak about it

Custom Sidebar is overriden by the plugins

Hello ! First thank's a lot for your work ! :)

I am facing two problems:

when we are using your component it broke every sidebar we make. Maybe i should just add another nav ?

sidebar: {
      "/guide/": [
        {
          title: "Guide",
          collapsable: false,
          children: ["", "getting-started", "colors", "borders", "fonts", "filters"]
        },
        {
          title: "Components",
          collapsable: false,
          children: ["components/buttons", "components/modals"]
        }
      ]
    }

It seem to break all sidebar navigation because the Home / Components

We can't use all vue-docgen-api when i want to use slot comment emit comment and class description maybe it's a choice ?

link to the issue

on window path seem to be bugged

We have to take care about window path. I will correct it but when he find for the path to get fileName.

In window the path look like path\blabla\ so not the same as unix. So we have to be more universel on it.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.