https://github.com/eeue56/elm-documentation-parser

https://github.com/eeue56/elm-documentation-parser

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/eeue56/elm-documentation-parser
• Owner: eeue56
• License: bsd-3-clause
• Created: 2018-01-25T22:21:53.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2018-01-26T00:46:42.000Z (almost 7 years ago)
• Last Synced: 2024-10-21T18:21:44.749Z (3 months ago)
• Language: TypeScript
• Size: 4.88 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# elm-documentation-parser

A parser for documentation from a folder with an elm-package.json in.

## Installation 

```

npm install --save elm-documentation-parser

```

## Usage

```javascript

readDocumentation("/home/noah/some-elm-project/elm-package.json")

.then((modules) => {

    // module information

});

```