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

grunt-react-docgen

v0.3.6

Published

Grunt plugin based on react-docgen and doctrine for react component doc json generate

Downloads

11

Readme

grunt-react-docgen

Grunt plugin based on react-docgen and doctrine for react component doc json generate.

快速上手

安装

npm install grunt-react-docgen --save-dev

Gruntfile.js

grunt.loadNpmTasks('grunt-react-docgen');

任务配置

概览

grunt.initConfig({
  react_docgen: {
    options: {
      // Task-specific options go here.
    },
    your_target: {
      // Target-specific file lists and/or options go here.
    },
  },
})

Options

options.entryFiles

  • Type: Array
  • Default value: ['index.jsx']

需要生成自动化文档的入口文件列表。

options.pkgInfo

  • Type: Object
  • Default value: require(path.join(process.cwd(), 'package.json'))

组件基本信息,默认取 package.json

options.demoEntryJSX

  • Type: String
  • Default value: 'demo/index.jsx'

组件 Demo 入口的 JSX 代码文件。

options.demoUrl

  • Type: String
  • Default value: '../demo/index.html'

组件 Demo 入口 url。

options.outputFilePath

  • Type: String
  • Default value: 'build/doc.html'

输出文档 HTML 文件路径。

options.templateFilePath

  • Type: String
  • Default value: tasks/doc.html

文档模板文件路径,默认为内置模板路径。

版本历史

  • [0.1.0]
    • 初始记录
  • [0.1.1]
    • 加上版本号 & tnpm version
  • [0.1.2]
    • hack for import React from 'base' instead of from 'react' directly.
  • [0.1.3][0.1.4]
    • fix & compatible for author field.
  • [0.1.5]
    • add flexible.js to doc.html
  • [0.2.0]
    • 从抓取 demo 内容改为指定 demo 路径通过 iframe 访问
  • [0.2.1]
    • 参考 material-ui 的 API 文档输出
  • [0.2.6]
    • Catch error for reactDocgen.parse
  • [0.2.7]
    • fix doc html style
  • [0.3.5]
    • 新增 options.templateFilePath 指定文档模板路径。

License

Copyright (c) 2015 dickeylth. Licensed under the MIT license.

Credits