package
markdown parser for github issues
npm install github-issue-parserGitHub-flavored package documentation.
Across all versions.
Download trend unavailable.
Runtime metadata.
This module parses github issue templates from markdown into plain JavaScript objects. It understands both markdown headers and list items.
Example:
* **Version**: 1.2.3
* **Operating System:** Mac
## Actual Behavior
some bad behavior
## Expected Behavior
some good behaviorconst issueParser = require('github-issue-parser')
const issueData = fs.readFileSync('/path/to/issue.md', 'utf8')
const jsonBlob = issueParser(issueData)
console.log(jsonBlob)
/*
{
'Version:': { raw: '1.2.3', html: '1.2.3' },
'Operating System:': { raw: 'Mac', html: 'Mac },
'Actual Behavior': {
raw: 'some bad behavior',
html: '<p>some bad behavior</p>'
},
'Expected Behavior': {
raw: 'some good behavior',
html: '<p>some good behavior</p>'
},
}
*/Estimated unpacked size across 34 packages.
1.3 MB
Includes dependencies.