speedymd
| Crates.io | speedymd |
| lib.rs | speedymd |
| version | 0.1.3 |
| source | src |
| created_at | 2024-09-08 07:57:40.43663 |
| updated_at | 2024-09-15 09:57:12.57469 |
| description | A CLI tool for setting up Markdown speedily. |
| homepage | https://github.com/taga3s/speedymd |
| repository | https://github.com/taga3s/speedymd |
| max_upload_size | |
| id | 1367833 |
| size | 30,918 |
Seiya Tagami (taga3s)
documentation
README
speedymd
A CLI tool for setting up Markdown speedily. 🚀
Install
- cargo
$ cargo install speedymd
[!WARNING] This crate is unstable. Any breaking changes may happen near future.
How to use?
Just run
$ speedymd
When you use this cli, you need to put the speedymd.config.json on the current directory.
Now, it supports
- Generating
.md (.mdx)file. - Customizing
Frontmatteras you like.
Configuration file speedymd.config.json
See example configuration file here.
| 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 |
License
MIT