about-json

about-json

This is an opinionated Markdown to JSON converter. It was designed to turn about-me markdown files like this one into a JSON structure for more flexible rendering.

It can read files locally or load them from the web.

Setup

npx about-json -i https://raw.githubusercontent.com/dkundel/about-me/master/README.md --pretty

# OR

npm i -g about-json
about-json -i https://raw.githubusercontent.com/dkundel/about-me/master/README.md --pretty

Usage

Turns a markdown file into a JSON. Opinionated based on the about-me file
format.
Usage: about-json -i <filePathOrUrl>

Options:
  --input, -i   File path or URL to load markdown            [string] [required]
  --output, -o  File path to write output. Will write to stdout otherwise.
                                                                        [string]
  --html        Output inline content (such as links) as HTML rather than
                Markdown                              [boolean] [default: false]
  --pretty      Prints the resulting JSON in an indented way instead of
                condensed                             [boolean] [default: false]
  --fixUrl, -u  If the content is fetched from the web, it will update the
                relative links to absolute URLs        [boolean] [default: true]
  --help        Show help                                              [boolean]
  --version     Show version number                                    [boolean]

Contributing

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Contributors

Thanks goes to these wonderful people (emoji key):

Dominik Kundel 💻

This project follows the all-contributors specification. Contributions of any kind welcome!

License

MIT