Lib.rs

› Command line utilities
#markdown #setting-up #command-line-tool #cli #rust

bin+lib speedymd

A CLI tool for setting up Markdown speedily

Owned by taga3s.

4 releases

0.1.3 Sep 15, 2024
0.1.2 Sep 15, 2024
0.1.1 Sep 8, 2024
0.1.0 Sep 8, 2024

#2334 in Command line utilities

Download history 180/week @ 2024-09-04 216/week @ 2024-09-11 29/week @ 2024-09-18 39/week @ 2024-09-25 39/week @ 2024-10-02 2/week @ 2024-10-09

149 downloads per month

MIT license

13KB
209 lines

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

  1. Generating .md (.mdx) file.
  2. Customizing Frontmatter as 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

Dependencies

~5–11MB
~96K SLoC