resource-docs v0.4.2

docs

for generating documentation

API

properties

• id

methods

• generate (resource, template)

• build ()

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/maraksquires/dev/bigcompany/resources/docs/template.md

docs.build()

builds README.md files for all resources

README auto-generated with docs