Giter VIP home page Giter VIP logo

vuepress-plugin-docgen's Introduction

lerna Commitizen friendly Build Status NPM Downloads

vuepress-plugin-docgen

Vuepress plugin for creating a documentation site of your Vue components

fast installation

yarn add -D vuepress-plugin-docgen

vuepress config file

plugins: [
  [ 'docgen',
    {
      componentsDir: path.join(__dirname, '../../components')
    }
  ]
]

documentation more infos click here

License

MIT ยฉ f3ltron

vuepress-plugin-docgen's People

Contributors

dependabot[bot] avatar elevatebart avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

vuepress-plugin-docgen's Issues

Multiple Component Directories

Hi @f3ltron! ๐Ÿ‘‹๐Ÿผ

Quick question, our components live in a monorepo and are each in their own subdirectory. Is there a way to get all *.vue file in a directory instead of pointing to a single directory like the example?

packages
โ”œโ”€โ”€ Alert
โ”‚   โ””โ”€โ”€ Alert.vue
โ”‚   โ””โ”€โ”€ Alert.spec.js
โ”œโ”€โ”€ Button
โ”‚   โ””โ”€โ”€ Button.vue
โ”‚   โ””โ”€โ”€ Button.spec.js
โ”œโ”€โ”€ Card
โ”‚   โ””โ”€โ”€ Card.vue
โ”‚   โ””โ”€โ”€ Card.spec.js

We're interested in trying out this plugin we just have a very specific codebase structure.

Thanks!

Components pages content div does not have the right class

<div class="content__default">
  <h1 id="tags">
    <a href="#tags" aria-hidden="true" class="header-anchor">#</a> Tags
  </h1>
  ...
</div>

while it should be as in any other vuepress page:

<div class="content default">
  <h1 id="tags">
    <a href="#tags" aria-hidden="true" class="header-anchor">#</a> Tags
  </h1>
  ...
</div>

issue require

take care about require when parsing for vue live

IMPORTANT INFORMATIONS | I JOINED VUEPRESS CORE TEAM

Hello I wanted to let you know i just arrived to Montreal ! I will comeback for working on the plugin at the end of august just to find my flat etc.

I applied to integrate vuepress core for plugins part or core.

My first work will be to finish the internationalization support. I did some R&D and found possible solutions.

After will work on the bug with core js for some functionals template errors.

Next will be the design of the preview to have something more smooth :).

I hope you like the plugin and thank's for the stars and you intereset

context in component

The problem is how we actually add context to componet. Like store / vueI18n for example

Hot Module reload when changing a documentation

Description

When running vuepress docs, saving a markdown file refreshes the content of the corresponding page. It is not the case with vue files that contain docs block.

Steps to reproduce

yarn docs
  • open a documented component
  • change anything and save
    -> the build is run but no updates are pushed to the documentation pages

Additional info

This might be due to dependencies not set correctly in the webpack plugin

Any vuepress plugin should start with `vuepress-plugin-`

We might have to change the name of the package to

vuepress-plugin-docgen

if we want to resolve it with string only.

today we have to configure it like so:

module.exports = {
  plugins: [
    [
      require("vuepress-component-docgen")
    ]
  ]
}

I would rather have this

module.exports = {
  plugins: [
    [
      'docgen'
    ]
  ]
}

improve dev environment

Actually we have to re run vuepress when we change things. We should add something that will watch and that we can run at the root folder

make the CI working again

Internationalization break generation of docs

The generation of the doc create folder and file no matter of locales.

Locales in vuepress need /zh/ etc subfolder if local is present. Effectively i didnt think about that before.

Easy to improve just add a local param and i have to change the generation and add more generation if local is present and change the sidebar override

Annoying Console log to be removed

When I run the docs, here is what I see:

tip Apply local theme at ~/vuejs-scaffold-tailwind/docs/.vuepress/theme...
tip Apply theme local ...
{ debug: false,
  sideBarName: 'components',
  globalName: 'Globals',
  regex: '/**/*.vue',
  templates:
   { components:
      { index: [Function],
        introduction: [Function],
        tags: [Function],
        props: [Function],
        slots: [Function],
        events: [Function],
success [13:57:40] Build 433b6d finished in 379 ms! (http://localhost:8080/)

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.