ShortLib is an open source project sheltering keyboard shortcuts for Windows, Mac and Linux.
- create a new folder in content (content/YOUR-FOLDER-NAME)
- add an icon to your new folder (content/YOUR-FOLDER-NAME/icon.svg)
- create an index.yaml file to your new folder (content/YOUR-FOLDER-NAME/index.yaml)
- fill index.yaml accordingly with metadata (see below or have a look at existing programs)
| Key | Description | (Example) value |
|---|---|---|
| name | name of the application | Super Cool Program |
| image_src | relative path to the applications icon | icon.svg |
| category | type of application | Developer |
| description | a short summary about the application | Once upon a time ... |
| developer | name of the developer | Super Cool Developer LLC |
| website | (official) site of the application | https://github.com |
| source | links to used references | https://github.com/fr0tt |
| OS | operating systems of defined shortcuts (if generate_linux is set to true linux shortcuts can be served without beeing defined) | windows and linux and mac |
| generate_linux | show linux users windows shortcut if no linux shortcut was defined | true or false |
| time | creation time in ISO-8061 format (https://www.w3.org/QA/Tips/iso-date) | 1970-12-25 or 1970-12-24T00:00:00.000Z |
- fill index.yaml accordingly with shortcuts (see below or have a look at existing programs)
name: Super Cool Program
image_src: icon.svg
category: Developer
description: Once upon a time ...
developer: Super Cool Developer LLC
website: 'https://github.com'
source: 'https://google.com/'
OS:
- windows
- mac
- linux
generate_linux: true
time: 1970-12-25
collection:
A cool section name:
-
description: There should be something happening.
windows:
-
- 'Ctrl'
- 'F'
mac:
-
- '⌘'
- 'F'- mobile "meant for"-design
- Table of Content
- anchor for sections
- production and dev enviroment variable (e.g. for vue.min)
- watch mode: show some sign of everything-is-ok after an error but only once
- support json as content type
- app.njk: only show host instead of full URL as a costum filter with https://nodejs.org/api/url.html#url_url_host
- create an API
- (some sort of) gui to create new content
- highlight frequently needed shortcuts
- support filter function by using synonyms (words/moby, FinNLP/synonyms, Datamuse API, WordsAPI, WordNET, thesaurus.altervista.org, abbreviations.com, dictionary.com, bighugelabs.com, watson.kmi.open.ac.uk, ..)
- list contributors with nodejs (https://github.com/github-tools/github)
- create pdfs if possible in browser (https://github.com/foliojs/pdfkit, https://github.com/marcbachmann/node-html-pdf (only nodejs), https://github.com/bpampuch/pdfmake)
- rebuild only parts instead of just rebuilding everything everytime
- support tags