npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@hperchec/vue-docgen-template

v1.2.0

Published

vue-docgen-cli extended default template (markdown)

Downloads

18

Readme

@hperchec/vue-docgen-template

Template for vue-docgen-cli including:

  • script handlers to extract component documentation:
    • get extends informations
    • get mixins informations
    • parse props doc blocks with jsDoc
    • parse methods doc blocks with jsDoc
  • doc blocks tag features (see below)
  • template engine similar to jsdoc2md/dmd written with Handlebars.js
  • createConfig util to create vue-docgen-cli config

This template make markdown output friendly for markdownlint

Usage

Use the createConfig method in vue-docgen-cli docgen.config.js configuration file:

const { createConfig } = require('@hperchec/vue-docgen-template')

const docgenConfig = createConfig({
  componentsRoot: 'src/components', // the folder where CLI will start searching for components.
  components: '**/[A-Z]*.vue', // the glob to define what files should be documented as components (relative to componentRoot)
  outDir: 'docs' // folder to save components docs in (relative to the current working directory)
}, {
  /* Template options */
})

module.exports = docgenConfig

See also API docs

Options

The createConfig method takes vue-docgen-cli config object as first parameter and options as second parameter:

  • options.helper?: String | String[]: handlebars helpers file(s)
  • options.partial?: String | String[]: handlebars partial file(s)
  • options.template?: String: handlebars root template as string
  • options.jsDoc?: Object: jsDoc options

See also API docs

Document component

Documentation object

Documentation object has now the following properties:

  • category: component category from @category tag
  • deprecated: if component is deprecated (from @deprecated tag)
  • isGloballyRegistered: true if component has @global tag
  • see: from @see tag
  • since: from @since tag
  • version: from @version tag

Doc blocks

Doc blocks are now parsed by jsDoc engine as Doclet objects.

Added tags:

  • @category tag will add category to component Documentation object category property (Array)

Changes:

  • @deprecated tag is exposed to component Documentation object deprecated property (Boolean | String)
  • @global tag will mark component as globally registered by Vue. It sets component Documentation object isGloballyRegistered property (Boolean) to true.
  • @see tag is exposed to component Documentation object see property (Array)
  • @since tag is exposed to component Documentation object since property (String)
  • @version tag is exposed to component Documentation object version property (String)

Props

PropDescriptor object

PropDescriptor object has now the following properties:

  • category: prop category from @category tag
  • deprecated: if prop is deprecated (from @deprecated tag)
  • see: from @see tag
  • since: from @since tag
  • values: prop values from @values tag
  • version: from @version tag

Doc blocks

Doc blocks are now parsed by jsDoc engine as Doclet objects.

Added tags:

  • @category tag will add category to PropDescriptor object category property (Array)

Changes:

  • @deprecated tag is exposed to component Documentation object deprecated property (Boolean | String)
  • @see tag is exposed to component Documentation object see property (Array)
  • @since tag is exposed to component Documentation object since property (String)
  • @values tag will add category to PropDescriptor object values property (Array)
  • @version tag is exposed to component Documentation object version property (String)

Methods

MethodDescriptor object

MethodDescriptor object has now the following properties:

  • category: prop category from @category tag
  • deprecated: if prop is deprecated (from @deprecated tag)
  • see: from @see tag
  • since: from @since tag
  • version: from @version tag

Doc blocks

Doc blocks are now parsed by jsDoc engine as Doclet objects.

Added tags:

  • @category tag will add category to MethodDescriptor object category property (Array)

Changes:

  • @deprecated tag is exposed to component Documentation object deprecated property (Boolean | String)
  • @see tag is exposed to component Documentation object see property (Array)
  • @since tag is exposed to component Documentation object since property (String)
  • @version tag is exposed to component Documentation object version property (String)