resource-docs

for generating documentation

npm install resource-docs
4 downloads in the last week
8 downloads in the last month

docs

for generating documentation

API

properties

methods

for generating documentation

  • id

    • type : any

methods

docs.generate(resource, template)

generates markdown documentation for a single resource

  • resource

    • description : the resource to generate documentation for

    • type : any

  • template

    • type : string

    • default : /Users/macbookpro/dev/big/resources/docs/template.md

docs.build()

builds README.md files for all resources

README auto-generated with docs

npm loves you