Guide To Describe a Toolkit

Toolkit starts with a little information about yourself, followed by the list of tools you are using. Tools may be grouped by categories.

This is how very minimal toolkit may look like:

name: John 🚀 Doe

> Photoshop (http://www.adobe.com/de/products/photoshop.html)

Try to copy it into the playground and see it works.

You can add more information about yourself besides just a name.
Supported lines are:

Also, those lines can be followed by some free text about yourself.

name: John 🚀 Doe
occupation: Designer
location: Berlin, Germany
link: https://works-for-me.github.io

Something about you …

After author's information goes the list of your tools.

Each tool starts with > symbol.

> WebStorm

It can have optional link and free text description:

> WebStorm (https://www.jetbrains.com/webstorm/)

Usefull plugins installed:
• IdeaVim
• Markdown Support
…

You can list similar tools in one line:

> Slack, Telegram (https://telegram.org)

Tools can be grouped with a titles to keep things more organised.

Title starts with --.

-- Programming

Just like with tools, title can be followed by some description.

-- Programming

My laptop is MacBook Pro (Retina, 15-inch, Mid 2015), 2,5 GHz Intel Core i7, 16GB of RAM.

After a title goes the list of related tools.

You can leave links to external resources within any free text description (for author's info, tools or titles).

Check out my <GitHub (https://github.com/nik-garmash)>

Link itself is wrapped with <>, inside are title and URL wrapped with ().

First, put images next to the *.toolkit file.

Start a line with # symbol followed by title and image URL.

# My desktop screenshot (./desktop.png)

Title is a text which describes what's on the image. It's very important for screen-reader users, do not skip it.

URL is wrapped with () and it refers to images you put inside your toolkit folder. External URLs are also good if you prefer.

// some reminder …

Such line won't be rendered.

Provide feedback