Compare commits

...

2 Commits

Author SHA1 Message Date
422bc1be2a
doc: refine quick start content
Signed-off-by: Brian McGee <brian@bmcgee.ie>
2024-05-01 09:26:27 +01:00
83de5b485e
fix: devshell commands for docs
Signed-off-by: Brian McGee <brian@bmcgee.ie>
2024-05-01 09:14:43 +01:00
2 changed files with 11 additions and 7 deletions

View File

@ -1,11 +1,15 @@
---
outline: none
---
# Quick start
To run `treefmt` in your project, please follow these steps:
1. [Install] the tool.
2. Install the needed formatters.
3. Run `treefmt --init`. This will generate the basic configuration file `treefmt.toml` containing the formatting rules.
4. Edit the configuration (see [here] how).
1. [Install] `treefmt`.
2. Install any formatters you wish to use with `treefmt`.
3. Run `treefmt --init` to generate a basic configuration file `treefmt.toml`.
4. Edit the configuration, adding formatters as desired. See [here] for more info on how to configure a formatter.
5. Run `treefmt` with the needed flags and options. You can check the supported options by executing `treefmt --help`.
In the following sections we will guide you through installing and configuring `treefmt` in detail.

View File

@ -35,19 +35,19 @@ _: {
inherit category;
name = "docs:dev";
help = "serve docs for local development";
command = "cd $PRJ_ROOT/docs && npm dev";
command = "cd $PRJ_ROOT/docs && npm run dev";
}
{
inherit category;
name = "docs:build";
help = "create a production build of docs";
command = "cd $PRJ_ROOT/docs && npm build";
command = "cd $PRJ_ROOT/docs && npm run build";
}
{
inherit category;
name = "docs:preview";
help = "preview a production build of docs";
command = "cd $PRJ_ROOT/docs && npm preview";
command = "cd $PRJ_ROOT/docs && npm run preview";
}
{
inherit category;