Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/taga3s/speedymd
A CLI tool for setting up Markdown speedily. :rocket:
https://github.com/taga3s/speedymd
cli markdown prompt rust
Last synced: 2 days ago
JSON representation
A CLI tool for setting up Markdown speedily. :rocket:
- Host: GitHub
- URL: https://github.com/taga3s/speedymd
- Owner: taga3s
- License: mit
- Created: 2024-09-07T14:12:39.000Z (21 days ago)
- Default Branch: main
- Last Pushed: 2024-09-15T12:44:13.000Z (13 days ago)
- Last Synced: 2024-09-15T22:44:30.444Z (12 days ago)
- Topics: cli, markdown, prompt, rust
- Language: Rust
- Homepage:
- Size: 44.9 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# speedymd
A CLI tool for setting up Markdown speedily. 🚀
## Install
- cargo
```bash
$ cargo install speedymd
```
> [!WARNING]
> This crate is unstable. Any breaking changes may happen near future.
## How to use?
Just run
```bash
$ speedymd
```
When you use this cli, you need to put the `speedymd.config.json` on the current directory.
Now, it supports
1. Generating `.md (.mdx)` file.
2. Customizing `Frontmatter` as you like.
## Config file `speedymd.config.json`
See example config file [here](https://github.com/taga3s/speedymd/blob/main/speedymd.config.json).
| key | description | required or not |
|-------------|-------------------------------------------|-----------------|
| ext | file extension, supporting `.md` or `.mdx`| required |
| outputPath | which path markdown would be outputted | required |
| frontmatter | frontmatter values | not |
- Specify frontmatter values
| key | description | required or not | example |
|-------------|----------------------------------------------------------------------------------|-----------------|----------------------------------|
| name | | required | title |
| type | supporting `text`, `boolean`, `select`, `multiselect` and `object` | required | text |
| question | | not | Please enter `title` |
| placeholder | | not | any title |
| options | when you specify `select` or `multiselect` to type, you need to specify this key | not | ["JavaScript", "Python", "Rust"] |
| properties | when you specify `object` to type, you need to specify this key | not | please see the example |
| required | | not | true |
## License
MIT