Skip to content

gramsco/docgen-nextjs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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

About

A simple doc generator for nextjs pages

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published