From 577c6086c0ef11bed2e655ece9c3136e3425aa2c Mon Sep 17 00:00:00 2001 From: Brian McGee Date: Wed, 1 May 2024 09:26:27 +0100 Subject: [PATCH] doc: refine quick start content Signed-off-by: Brian McGee --- docs/quick-start.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/docs/quick-start.md b/docs/quick-start.md index e190258..d0783bd 100644 --- a/docs/quick-start.md +++ b/docs/quick-start.md @@ -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.