docgen-nextjs

0.0.2 • Public • Published

DOCGEN-NEXTJS

A simple doc generator for NextJS pages.

npx docgen-nextjs

will create a documentation for each and every page you have.

Add in your files:

// __description__

to describe what the page is / does

// __staticPaths__

to describe how the paths are generated

// __staticProps__

to describe which props are going to be passed

TODO:

  • Really analyze the paths (fallback ?)
  • Really analyze the props (revalidate, etc.)
  • maybe integrate with JSDOC

Package Sidebar

Install

npm i docgen-nextjs

Weekly Downloads

1

Version

0.0.2

License

ISC

Unpacked Size

3.03 kB

Total Files

5

Last publish

Collaborators

  • gramsco