1
0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-11-27 03:57:21 +00:00
TiddlyWiki5/plugins/tiddlywiki/bibtex/files/README.md

48 lines
1.1 KiB
Markdown

bibtexParseJs
=============
A JavaScript library that parses BibTeX parser. Forked from
[bibtex-parser](https://github.com/mikolalysenko/bibtex-parser).
## Using in Browser
Include bibtexParse.js and call
```
bibtexParse.toJSON('@article{sample1,title={sample title}}');
```
## Using in [Node.js](http://nodejs.org/)
Install ```npm install bibtex-parse-js```
```
var bibtexParse = require('bibtex-parse-js');
var sample = bibtexParse.toJSON('@article{sample1,title={sample title}}');
console.log(sample);
```
**Returns** A parsed bibtex file as a JSON Array Object
```
[ { citationKey: 'SAMPLE1',
entryType: 'ARTICLE',
entryTags: { TITLE: 'sample title' } } ]
```
## Contributing
Contributions are welcome. Please make sure the unit test(test/runTest.js) reflects the
changes and completes successfully.
#### Travis CI
See the latest build and results at [https://travis-ci.org/ORCID/bibtexParseJs](https://travis-ci.org/ORCID/bibtexParseJs)
## Credits
(c) 2010 Henrik Muehe. MIT License
[visit](https://code.google.com/p/bibtex-js/)
CommonJS port maintained by Mikola Lysenko
[visit](https://github.com/mikolalysenko/bibtex-parser)