configs returns the default configuration template
()
| 2 | |
| 3 | // configs returns the default configuration template |
| 4 | func configs() string { |
| 5 | return `--- |
| 6 | # The editor to use with 'cheat -e <sheet>'. Overridden by $VISUAL or $EDITOR. |
| 7 | editor: EDITOR_PATH |
| 8 | |
| 9 | # Should 'cheat' always colorize output? |
| 10 | colorize: false |
| 11 | |
| 12 | # Which 'chroma' colorscheme should be applied to the output? |
| 13 | # Options are available here: |
| 14 | # https://github.com/alecthomas/chroma/tree/master/styles |
| 15 | style: monokai |
| 16 | |
| 17 | # Which 'chroma' "formatter" should be applied? |
| 18 | # One of: "terminal", "terminal256", "terminal16m" |
| 19 | formatter: terminal256 |
| 20 | |
| 21 | # Through which pager should output be piped? |
| 22 | # 'less -FRX' is recommended on Unix systems |
| 23 | # 'more' is recommended on Windows |
| 24 | pager: PAGER_PATH |
| 25 | |
| 26 | # The paths at which cheatsheets are available. Tags associated with a cheatpath |
| 27 | # are automatically attached to all cheatsheets residing on that path. |
| 28 | # |
| 29 | # Whenever cheatsheets share the same title (like 'tar'), the most local |
| 30 | # cheatsheets (those which come later in this file) take precedence over the |
| 31 | # less local sheets. This allows you to create your own "overides" for |
| 32 | # "upstream" cheatsheets. |
| 33 | # |
| 34 | # But what if you want to view the "upstream" cheatsheets instead of your own? |
| 35 | # Cheatsheets may be filtered by 'tags' in combination with the '--tag' flag. |
| 36 | # |
| 37 | # Example: 'cheat tar --tag=community' will display the 'tar' cheatsheet that |
| 38 | # is tagged as 'community' rather than your own. |
| 39 | # |
| 40 | # Paths that come earlier are considered to be the most "global", and paths |
| 41 | # that come later are considered to be the most "local". The most "local" paths |
| 42 | # take precedence. |
| 43 | # |
| 44 | # See: https://github.com/cheat/cheat/blob/master/doc/cheat.1.md#cheatpaths |
| 45 | cheatpaths: |
| 46 | |
| 47 | # Cheatsheets that are tagged "personal" are stored here by default: |
| 48 | - name: personal |
| 49 | path: PERSONAL_PATH |
| 50 | tags: [ personal ] |
| 51 | readonly: false |
| 52 | |
| 53 | # Cheatsheets that are tagged "work" are stored here by default: |
| 54 | - name: work |
| 55 | path: WORK_PATH |
| 56 | tags: [ work ] |
| 57 | readonly: false |
| 58 | |
| 59 | # Community cheatsheets (https://github.com/cheat/cheatsheets): |
| 60 | # To install: git clone https://github.com/cheat/cheatsheets COMMUNITY_PATH |
| 61 | - name: community |