https://github.com/devramsean0/tjp-to-md
https://github.com/devramsean0/tjp-to-md
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/devramsean0/tjp-to-md
- Owner: devramsean0
- Created: 2024-06-02T06:51:29.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-04-12T04:10:35.000Z (about 1 year ago)
- Last Synced: 2025-04-18T04:54:34.401Z (about 1 year ago)
- Language: Rust
- Size: 22.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.MD
Awesome Lists containing this project
README
# TJP-TO-MD
A CLI tool to take the markdown generated by [Typedoc JSON Parser](https://npmjs.com/package/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:
```toml
input_dir= ""
output_dir = ""
max_threads = 5
regen_all = false
```
Alternatively, you can run `tjp-to-md gen_config`
## License
This project is licensed under MIT :)