nixlets/docs/generating_docs.md

Generating Docs

Like you can see on the left (if you are looking at the built MkDocs site), it's possible to generate docs for Nixlets' values automatically. Since the values are basically just Nix module options, we can generate docs similarly to NixOS options etc.

Generate Markdown

This is all that's needed:

(<nixlet>).mkDocs {
# Params:
#  fullValues ? false,
#  transformOptions ? opt: opt,
#  filter ? _: true,
#  headingDepth ? 3,
}

This will return the path to a markdown file containing the docs, like this:

### `example`

(no description)

**Type**:

```console
string
```

**Default value**:

```nix
"Hello world!"
```

The fullValues param controls whether the docs should include dependency Nixlets. For example, when defining postgres as a dependency, by default the docs would not include these options. If it's true, everything is included.

Dependency Nixlets' options which you override from your own values.nix will show both default values:

**Overridden value**:

```nix
<the overridden value set in values.nix>
```