Skip to content

Instantly share code, notes, and snippets.

@montanaflynn
Last active August 29, 2015 14:10
Show Gist options
  • Save montanaflynn/cd7cc3ed910aa87017a5 to your computer and use it in GitHub Desktop.
Save montanaflynn/cd7cc3ed910aa87017a5 to your computer and use it in GitHub Desktop.
doc.md
# Project // pull from package.json

description // pull from package.json

# Install 

installation // pull from examples.md

# Usage

apiDocs // build from api.md

# Examples

exampleCode // build from examples.md

# Contributing

contributionGuide // build from package.json

# License

Copyright // build from package.json

license // build from package.json

method(arg1, arg2) => string

arg1: string

arg2: object

  • returnDay : boolean = true|option:false
  • format : string = json|options:xml,tsv,csv,yaml
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment