Skip to content

Commit

Permalink
Document the feature for custom config file placement
Browse files Browse the repository at this point in the history
  • Loading branch information
dhruvkb committed Dec 29, 2023
1 parent 6f3d2bc commit e91e028
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion docs/src/content/docs/reference/conf.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,20 @@ of powerful customization options. Configuration is specified in the form of a
`.pls.yml` YAML file (which means you can just use JSON if you hate YAML so
much).

This is the schema of the file.
## Placement

<Pls /> uses a cascading system for multiple config files. You can have config
files at the directory level, at the repository level and at the global level.

The global config file can be placed in the home directory at `~/.pls.yml`. If
you prefer a clean home directory, you can set the `PLS_CONFIG` environment
variable to a point to a config file placed elsewhere on your computer, in which
case <Pls /> will not look for one in the home directory.

## Schema

This is the schema of the file.

<DocBlock title="icons" type="map<str, str>">
<Fragment slot="heading">
### icons
Expand Down

0 comments on commit e91e028

Please sign in to comment.