Giter Club home page Giter Club logo

Comments (8)

happylittleboozer avatar happylittleboozer commented on May 13, 2024 1

@lancetharper, @Minasokoni you can fix this by setting propsParser function in your styleguide.config.js. Like this:

const path = require('path');

module.exports = {
  propsParser (filePath, source) {
    var props = require('vue-docgen-api').parse(filePath);
    // Set component displayName as component folder name
    props.displayName = path.basename( path.dirname( props.displayName ) );
    return props;
  }
};

from vue-styleguidist.

rafaesc avatar rafaesc commented on May 13, 2024

Please share your repository, to review it, thanks!

from vue-styleguidist.

lancetharper avatar lancetharper commented on May 13, 2024

I appreciate the help! We think this looks very promising.

https://github.com/rei/rei-cedar/tree/feature/styleguidist

from vue-styleguidist.

rafaesc avatar rafaesc commented on May 13, 2024

I see you have a great project!

Ok I just created a pull request, and update the documentation

Https://github.com/vue-styleguidist/vue-styleguidist/blob/master/docs/Documenting.md#usage-examples-and-readme-files

Note: vue-docgen-api The default name of the component is the name of the .vue file. If you need a custom name configuration, type as an issue in vue-docgen-api

If you publish the styleguide of your project please share it in the readme

https://github.com/vue-styleguidist/vue-styleguidist#showcases

Regards

from vue-styleguidist.

Minasokoni avatar Minasokoni commented on May 13, 2024

@rafaesc92 Im running into the same issue
screen shot 2017-06-15 at 7 52 54 am

from vue-styleguidist.

Minasokoni avatar Minasokoni commented on May 13, 2024

@happylittleboozer Thanks!

from vue-styleguidist.

rafaesc avatar rafaesc commented on May 13, 2024

Thanks to everyone, the solution is in vue-docgen-api, I forgot to use path.normalize to extract the file name, I'm going to update it

from vue-styleguidist.

rafaesc avatar rafaesc commented on May 13, 2024

The repository was updated.

The name of the component is equal to the property defined in the name component, this is required.

Upgrade to version 1.1.1

from vue-styleguidist.

Related Issues (20)

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.