docs/quick-start.md

@@ -1,15 +1,11 @@
----
-outline: none
----
-
 # Quick start
 
 To run `treefmt` in your project, please follow these steps:
 
-1. [Install] `treefmt`.
+1. [Install] the tool.
-2. Install any formatters you wish to use with `treefmt`.
+2. Install the needed formatters.
-3. Run `treefmt --init` to generate a basic configuration file `treefmt.toml`.
+3. Run `treefmt --init`. This will generate the basic configuration file `treefmt.toml` containing the formatting rules.
-4. Edit the configuration, adding formatters as desired. See [here] for more info on how to configure a formatter.
+4. Edit the configuration (see [here] how).
 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.

nix/docs.nix

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