# 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.

## Configuration file `speedymd.config.json`

See example configuration 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           |

## License

MIT