markdown-to-json's Introduction

markdown-to-json

Markdown to JSON converter for jsdoc-to-markdown output

Requirements
Installation
Usage
Support
Structure

Requirements

Program	Function	Optional	Download
jsdoc2md	JSDoc annotation to markdown	❌	💾

Installation

Download a copy of this repository to your system.

Git clone

git clone https://github.com/Justin-Byrne/markdown-to-json.git

Usage

Help menu

python3 md2json.py {<source>} [<destination>] [flags]

PATHS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

source:         Directory of JSDoc markdown file(s)

    usage:          "../jsdoc-to-markdown"

destination:    Directory of JSON output

    usage:          "../markdown-to-json"

FLAGS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

-h, --help  Display this help menu

    usage:          --help

Support

Please open an issue for support.

Structure

.
├── docs
│   ├── CHANGELOG.md
│   └── FUNDING.yml
├── source
│   └── app
│       ├── core
│       │   └── markdown2json.py
│       ├── utilities
│       │   ├── custom
│       │   │   ├── debug
│       │   │   │   └── view_arguments.py
│       │   │   └── validation
│       │   │       └── is_extension.py
│       │   ├── system
│       │   │   ├── file
│       │   │   │   ├── get_files.py
│       │   │   │   └── set_file.py
│       │   │   ├── validation
│       │   │   │   ├── is_directory.py
│       │   │   │   ├── is_file.py
│       │   │   │   └── is_flag.py
│       │   │   ├── get_commands.py
│       │   │   └── parse_commands.py
│       │   └── util.py
│       └── md2json.py
├── LICENSE.md
└── README.md