-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
36 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,39 @@ | ||
# mdsf | ||
|
||
Format markdown code snippets using your favorite code formatters. | ||
|
||
## Installation | ||
|
||
The latest version of `mdsf` can be downloaded directly from [github.com/hougesen/mdsf/releases](https://github.com/hougesen/mdsf/releases). | ||
|
||
### Cargo | ||
|
||
Install using the [published crate](https://crates.io/crates/mdsf): | ||
|
||
```sh | ||
cargo install mdsf | ||
``` | ||
|
||
or directly from source: | ||
|
||
```sh | ||
git clone [email protected]:hougesen/mdsf.git | ||
|
||
cargo install --path ./mdsf --bin mdsf | ||
``` | ||
|
||
## Usage | ||
|
||
```sh | ||
mdsf format NAME_OF_FOLDER_OR_FOLDER | ||
``` | ||
|
||
## Configuration | ||
|
||
The default configuration of `mdsf` aims to as sane as possible. For that reason the default formatter for each language is the one most people have installed. | ||
|
||
If you are interested in customizing which formatter is run, you can create a new `mdsf` configuration file by running | ||
|
||
```sh | ||
mdsf init | ||
``` |