skillmap
A tool for generating skill map/tree like diagram.
What is a skill map/tree?
Skill tree is a term used in video games, and it can be used for describing roadmaps for software project development as well. When you are building a software project, you can use the concept of skill tree/technology tree to describe the steps you need to take to build the project.
In strategy games, a technology, tech, or research tree is a hierarchical visual representation of the possible sequences of upgrades a player can take (most often through the act of research). Because these trees are technically directed and acyclic, they can more accurately be described as a technology directed acyclic graph. -- https://en.wikipedia.org/wiki/Technology_tree
This project borrows inspiration and ideas from several sources:
- https://hacks.mozilla.org/2018/10/webassemblys-post-mvp-future/
- https://github.com/nikomatsakis/skill-tree
- https://en.wikipedia.org/wiki/Technology_tree
Features
- skill tree/map generation
- specify pre-requisite skills
- multiple themes
- multiple skill progress bar styles
Installation
pip install skillmap
After installation, a skillmap command is available.
Usage
- Create a toml format skill map descriptor file. You can find more details about this descriptor format here. For a minimal example, see
docs/examples/hello_world.toml
[skillmap]
name = "hello world"
icon = "bicycle"
[groups.learn_python]
name = "learn python"
icon = "rocket"
[groups.learn_python.skills.print]
name = "print statement"
icon = "printer"
[groups.learn_python.skills.string]
name = "string literal"
icon = "book"
- Run
skillmap path/to/your/skillmap.toml- For example,
skillmap docs/examples/hello_world.toml
- For example,
- Copy the generated skill map diagram to your clipboard.
- Paste the diagram to a mermaid diagram editor, for example,
https://mermaid-js.github.io/mermaid-live-editor.
Examples
- Each node can have a string label and an fontawsome icon.
- Skills with different statuses will be shown with different colors.
- Each skill may have a progress bar to indicate its learning progress.
- Pre-requisite skills will be connected with an directed edge.
- You can embed the generated mermaid diagram into github markdown directly, but the fontawesome icons in the diagrams are not shown by github so far.
- Unnamed skill (a skill node only has its toml table id but without any table property) will be shown as a locked skill. I find this is a useful analogy when you have a problem in your project that you don't have any clue how it should be solved yet.
- You can find the skill map toml for the above exmaples here
License
More details
- Skillmap toml descriptor format can be found here
- hot reloading when authoring a skillmap toml file
- install several tools to make hot reloading to work
entr, run arbitrary commands when files change- Visual Studio Code + Markdown Preview Enhanced Visual Studio Code Extension
- Basically, use
entrto watch toml file changes, and generate amdmakrdown file usingskillmapevery time when toml file changes. And usevscode+Markdown Preview Enhancedextension to open this generated markdown file. Check outbuild_sampleanddev_samplein justfile to see how to make hot reloading work
- install several tools to make hot reloading to work
Known issues
- Sometimes, the group's text will be clipped when rendered in mermaid. And you have to edit the generated file slightly and then change it back to ask mermaid to refersh the diagram to avoid clipping. It is probably a bug for mermaid as far as I can tell.
24 May 16, 2022
7 Dec 16, 2022
3 Aug 17, 2022
6 Oct 18, 2022
136 Dec 23, 2022
241 Jan 1, 2023
2 Apr 23, 2022
2 Dec 20, 2021
2 Dec 24, 2021
1 Jan 10, 2022
8 Oct 04, 2022
19 Oct 20, 2022
1 Dec 23, 2021
1 Jan 08, 2022
0 Jan 05, 2022
2 Jul 01, 2022
80 Jan 04, 2023
142 Jan 05, 2023
18 Sep 19, 2022
2 Dec 04, 2021
1 Feb 01, 2022
17 Nov 27, 2022
15 Aug 11, 2022
5.9k Jan 02, 2023
3 Sep 22, 2022
21 Dec 06, 2021
6 Jan 07, 2022
7 Apr 17, 2022
1.7k Jan 07, 2023