From e91e0287fe0a9d5b740636d2f8b3f0c950b673e2 Mon Sep 17 00:00:00 2001 From: Dhruv Bhanushali Date: Fri, 29 Dec 2023 14:35:09 +0400 Subject: [PATCH] Document the feature for custom config file placement --- docs/src/content/docs/reference/conf.mdx | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/docs/src/content/docs/reference/conf.mdx b/docs/src/content/docs/reference/conf.mdx index e1a8111..9141cf1 100644 --- a/docs/src/content/docs/reference/conf.mdx +++ b/docs/src/content/docs/reference/conf.mdx @@ -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 + + 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 will not look for one in the home directory. ## Schema +This is the schema of the file. + ### icons