wjnbreu / shortcuts-design-data

Home Page:http://shortcuts.design/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Shortcuts.design β€” Every shortcuts for designers, centralized and searchable.

Status Contact

Shortcuts.design V2.0

Introduction

Hi, I'm Michel, the creator of Shortcuts.design. Shortcuts.design lists every shortcut for designers in one place and in a simple and clear way. It's a centralized and searchable online database that helps over 10K designers every month to quickly charge their workflow. Whether you're a beginning designer looking to work more efficient, when you switched to a new designtool or when you just want a reference to see which shortcut to use for that action you have to do all day long, it'll help you get there.

Contributing

Please use GitHub issues to report any bugs or feature requests. If you can fix it yourself, please fix it and send in a pull request.

Note: all data is in plain HTML, we're working on that πŸ˜…

Running the project

Shortcuts.design runs on [Eleventy](eleventy is a simpler static site generator.). Use the following commands to get started:

  • Install: npm install
  • Build: npx @11ty/eleventy
  • Run: npx @11ty/eleventy --serve

Changing data

Edit the data of a specific tool in data/{category}/{toolpages-toolname.html}.

Adding tools

  1. Add a new file to /tools, for example toolspage-{tool-name-here}.md with the following data:

    ---
    layout: layouts/tool.njk
    tool: {tool-name-here}
    os1: Mac {leave empty if only Mac or Windows}
    os2: Windows {leave empty if only Mac or Windows}
    toolSlug: {tool-name-with-dashes}
    toolGroup: {pick from *Design*, *Development* or *Productivity*}
    toolDescription: {write a description about the tool here}
    toolLink: {link to the tool here}
    toolLinkDescription: {how the link should be displayed}
    ---
    
  2. Add a logo to assets/img with the following naming-convention: logo-{toolslug-here}.png, logo's should be 264*264px.

  3. Add the data to data/{category}/. Use the formating instructions below. For quick generation of the needed HTML, use the following file:

Symbols

Please keep the code/data clean and consistent by using the following symbols when adding shortcuts on Mac tools-pages:

Key Symbol
Control βŒƒ
Option / Alt βŒ₯
Command ⌘
Shift ⇧
Enter ↩
Arrow keys ↑ ↓ ← β†’

Using GitHub

In case you don't know how to contribute using GitHub, please check out this short post.

About the designer / developer

Hi, I'm Michel, I created Shortcuts.design to help others charge their workflow. I'm a Product Designer on a mission to build products for others that enable them to become more productive and effective Β· Product Design @YipYip Β· Prev @WeTransfer & @Awkward.

Links

About

http://shortcuts.design/


Languages

Language:HTML 86.0%Language:SCSS 5.8%Language:Less 5.7%Language:CSS 1.3%Language:Nunjucks 0.9%Language:JavaScript 0.2%