mirror of
https://gitlab.com/TECHNOFAB/nixlets.git
synced 2026-03-22 18:49:28 +01:00
docs: document importing nixlets
This commit is contained in:
parent
2c21317f45
commit
906cd9db2d
3 changed files with 45 additions and 0 deletions
|
|
@ -11,6 +11,7 @@ This is all that's needed:
|
|||
```nix
|
||||
(<nixlet>).mkDocs {
|
||||
# Params:
|
||||
# fullValues ? false,
|
||||
# transformOptions ? opt: opt,
|
||||
# filter ? _: true,
|
||||
# headingDepth ? 3,
|
||||
|
|
@ -36,3 +37,18 @@ string
|
|||
"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:
|
||||
|
||||
````md
|
||||
**Overridden value**:
|
||||
|
||||
```nix
|
||||
<the overridden value set in values.nix>
|
||||
```
|
||||
````
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue