DOCSEARCHbyAlgolia
Submit Docs

kapeli/cheatsheets

repository·master·Indexed 21 days ago

https://github.com/kapeli/cheatsheets

Source files for Dash cheat sheets, generated using the cheatset tool. This repository serves as a central collection for community contributions via pull requests and provides guidelines for naming, formatting, and keyboard shortcut standards for the Dash search index.

Tokens
255
Snippets
1
Records
2
Agent score
24%

What's inside kapeli-cheatsheets

  1. How to create or modify Dash cheat sheets

    master

    Dash cheat sheets are generated using the cheatset tool. To modify an existing cheat sheet, fork this repository and locate the target files within the cheatsheets folder. For instructions on the generation process and the specific file format used to define cheat sheets, refer to the cheatset documentation.

    https://github.com/Kapeli/cheatset#readme

  2. Guidelines for naming and formatting cheat sheets

    master

    When creating or modifying cheat sheets, follow these formatting standards to ensure consistency in the Dash search index:

    • Naming: Keep categories, commands, and names concise, as these are used directly in the Dash search index. Use notes for additional details.
    • Casing:
      • Use Title Case for categories only.
      • Use Sentence case for everything else, including menu item names.
    • Keyboard Shortcuts:
      • Avoid including extremely common shortcuts (e.g., Copy, Paste, Undo).
      • List keyboard modifiers in this specific order: CMD+CTRL+OPTION+SHIFT.