mirror of
https://github.com/njvack/markdown-to-json.git
synced 2026-04-22 03:02:02 -04:00
Update README
This commit is contained in:
36
README.md
36
README.md
@@ -23,7 +23,9 @@ This is an example file
|
||||
# Authors
|
||||
|
||||
* Nate Vack
|
||||
* Someone Else
|
||||
* Vendor Packages
|
||||
* docopt
|
||||
* CommonMark-py
|
||||
|
||||
# Versions
|
||||
|
||||
@@ -41,7 +43,7 @@ will translate to the JSON:
|
||||
```
|
||||
{
|
||||
"Description": "This is an example file",
|
||||
"Authors": ["Nate Vack", "Someone Else"],
|
||||
"Authors": ["Nate Vack", "Vendor Packages", ["docopt", "CommonMark-py"]],
|
||||
"Versions": {
|
||||
"Version 1": "Here's something about Version 1; I said \"Hooray!\"",
|
||||
"Version 2": "Here's something about Version 2"
|
||||
@@ -49,3 +51,33 @@ will translate to the JSON:
|
||||
}
|
||||
```
|
||||
|
||||
## `md_to_json`
|
||||
|
||||
```
|
||||
Translate markdown into JSON.
|
||||
|
||||
Usage:
|
||||
md_to_json [options] <markdown_file>
|
||||
md_to_json -h | --help
|
||||
|
||||
Options:
|
||||
-h --help Show this screen
|
||||
--version Print version number
|
||||
-o <file> Save output to a file instead of stdout
|
||||
-i <val> Indent nested JSON by this amount. Use a negative number for
|
||||
most compact possible JSON. the [default: 2]
|
||||
```
|
||||
|
||||
This translates a markdown document into JSON as described in the example above.
|
||||
|
||||
## Credits
|
||||
|
||||
`markdown_to_json` was written by Nate Vack <njvack@freshforever.net> at the Center for Healthy Minds at the University of Wisconsin–Madison.
|
||||
|
||||
This tool ships a few really excellent tools in its `vendor` directory:
|
||||
|
||||
[docopt](https://github.com/docopt/docopt) is copyright (c) 2012 Vladimir Keleshev, <vladimir@keleshev.com>
|
||||
|
||||
[CommonMark-py](https://github.com/rolandshoemaker/CommonMark-py) is copyright Copyright (c) 2014, Bibek Kafle and Roland Shoemaker
|
||||
|
||||
The packaged ordereddict implementation is copyright (c) 2009 Raymond Hettinger
|
||||
Reference in New Issue
Block a user