summarylogtreecommitdiffstats
path: root/conf.yml
diff options
context:
space:
mode:
authoryochananmarqos2020-01-31 08:37:25 -0700
committeryochananmarqos2020-01-31 08:37:25 -0700
commitf013bea2acbbe21036e3b9667cd4e31be19079b3 (patch)
treeb6eeb18129a1d7e630817d75611d363bd6c64132 /conf.yml
parent1a069712ab4476699e9acae37fc80346df3456e9 (diff)
downloadaur-f013bea2acbbe21036e3b9667cd4e31be19079b3.tar.gz
updated to 3.4.1
Diffstat (limited to 'conf.yml')
-rw-r--r--conf.yml25
1 files changed, 14 insertions, 11 deletions
diff --git a/conf.yml b/conf.yml
index d4402bc867fb..d214f5f79bc5 100644
--- a/conf.yml
+++ b/conf.yml
@@ -1,6 +1,6 @@
---
# The editor to use with 'cheat -e <sheet>'. Defaults to $EDITOR or $VISUAL.
-#editor: vim
+editor: vim
# Should 'cheat' always colorize output?
colorize: true
@@ -47,16 +47,19 @@ cheatpaths:
tags: [ community ]
readonly: true
- # Maybe your company or department maintains a repository of cheatsheets as
- # well. It's probably sensible to list those second.
- #- name: work
- #path: ~/.dotfiles/cheat/work
- #tags: [ work ]
- #readonly: false
-
# If you have personalized cheatsheets, list them last. They will take
# precedence over the more global cheatsheets.
#- name: personal
- #path: ~/.dotfiles/cheat/personal
- #tags: [ personal ]
- #readonly: false
+ # path: ~/cheat/cheatsheets/personal
+ # tags: [ personal ]
+ # readonly: false
+
+ # While it requires no specific configuration here, it's also worth noting
+ # that 'cheat' will automatically append directories named '.cheat' within
+ # the current working directory to the 'cheatpath'. This can be very useful
+ # if you'd like to closely associate cheatsheets with, for example, a
+ # directory containing source code.
+ #
+ # Such "directory-scoped" cheatsheets will be treated as the most "local"
+ # cheatsheets, and will override less "local" cheatsheets. Likewise,
+ # directory-scoped cheatsheets will always be editable ('readonly: false').