typedoc_json_to_md
| Crates.io | typedoc_json_to_md |
| lib.rs | typedoc_json_to_md |
| version | 0.3.3 |
| source | src |
| created_at | 2024-06-02 08:46:56.364293 |
| updated_at | 2024-06-03 14:24:21.309383 |
| description | Converts TypeDoc JSON generated by typedoc-json-parser to Markdown |
| homepage | |
| repository | https://github.com/devramsean0/tjp-to-md |
| max_upload_size | |
| id | 1259076 |
| size | 32,080 |
Sean Outram (devramsean0)
documentation
README
TJP-TO-MD
A CLI tool to take the markdown generated by Typedoc JSON Parser and turn it into Markdown Files
Reasoning
- MD files is easier to display on a site than a specialised JSON file.
- Using ESM only modules with next has caused me issues in the past.
- Allows for viewing within GitHub / Any Markdown Viewer
- Allows projects to copy relevant parts of documentation easier
Configuration:
The CLI can be configured by placing a tjp_to_md.toml file into the root of the fiolder where the parsing will happen.
This should look like:
input_dir= "<your input directory>"
output_dir = "<your output directory>"
max_threads = 5
regen_all = false
Alternatively, you can run tjp-to-md gen_config
License
This project is licensed under MIT :)