https://github.com/lucasepe/crumbs
Turn asterisk-indented text lines into mind maps
https://github.com/lucasepe/crumbs
commandline golang graphviz mindmaps text-to-image
Last synced: 7 months ago
JSON representation
Turn asterisk-indented text lines into mind maps
- Host: GitHub
- URL: https://github.com/lucasepe/crumbs
- Owner: lucasepe
- License: mit
- Created: 2020-09-08T15:06:01.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2020-09-11T19:31:46.000Z (over 5 years ago)
- Last Synced: 2024-08-10T11:02:38.269Z (over 1 year ago)
- Topics: commandline, golang, graphviz, mindmaps, text-to-image
- Language: Go
- Homepage:
- Size: 468 KB
- Stars: 105
- Watchers: 4
- Forks: 11
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Crumbs
> Turn asterisk-indented text lines into mind maps.
Organize your notes in a hierarchical tree structure, using a simple text editor.
- an asterisk at the beginning of the line means _level 1_
- two asterisk at the beginning of the line means _level 2_
- and so on...
# How [crumbs](https://github.com/lucasepe/crumbs/releases/latest) works?
- takes in input a text file and generates a [dot script](https://en.wikipedia.org/wiki/DOT_(graph_description_language)) for [Graphviz](https://graphviz.gitlab.io/download/).
- depends on [GraphViz](https://graphviz.gitlab.io/download/)
- look at the bottom for info about [how to install graphviz](#how-to-install-graphViz).
## Example (without icons)
Create a simple text file - let's say `meeting-ideas.txt`:
```text
* main idea
** topic 1
*** sub topic
*** sub topic
**** sub topic
**** sub topic
** topic 2
*** sub topic
```
To create the PNG image you can
- _"inject"_ the text file to [crumbs](https://github.com/lucasepe/crumbs/releases/latest) and then the result to [dot](https://graphviz.org/doc/info/command.html) redirecting the output to the file `meeting-ideas.png` - (I love the Linux command pipelines! 😍)
```bash
cat meeting-ideas.txt | crumbs | dot -Tpng > meeting-ideas.png
```
- or as alternative you can specify your text file to [crumbs](https://github.com/lucasepe/crumbs/releases/latest) directly:
```bash
crumbs meeting-ideas.txt | dot -Tpng > meeting-ideas.png
```
Here the output:
---
## Example (with icons)
You can, eventually, add images too (one for text line) using a special syntax: `[[path/to/image.png]]`
- if you specify the flag `-image-path` you can write `[[image.png]]` instead of `[[path/to/image.png]]`
- if you specify the flag `-image-type` you can write `[[path/to/image]]` instead of `[[path/to/image.png]]`
- therefore if you specify both you can write `[[image]]` instead of `[[path/to/image.png]]`
```text
* [[./png/bulb.png]] main idea
** topic 1
*** sub topic
*** sub topic
**** [[./png/comments-alt.png]] sub topic
**** sub topic
** [[./png/map-signs.png]] topic 2
*** sub topic
```
then as usual, let's feed graphviz with [crumbs](https://github.com/lucasepe/crumbs/releases/latest):
```bash
crumbs meeting-ideas-with-icons.txt | dot -Tpng > meeting-ideas-with-icons.png
```
and the output is...
## Example (with HTML)
You can enrich the output with a little bit of style, adding some HTML tag.
The following tags are understood:
```html
,
, , , , , ,
```
```text
* main idea
** topic 1
*** sub topic
*** sub topic
**** sub topic
**** sub topic
** topic 2
*** sub topic
```
then as usual, let's feed graphviz with [crumbs](https://github.com/lucasepe/crumbs/releases/latest):
```bash
crumbs meeting-ideas-with-html.txt | dot -Tpng > meeting-ideas-with-html.png
```
and the output is...
---
# Installation Steps
In order to use the crumbs command, compile it using the following command:
```bash
go get -u github.com/lucasepe/crumbs/crumbs
```
This will create the crumbs executable under your $GOPATH/bin directory.
## Ready-To-Use Releases
If you don't want to compile the sourcecode yourself, [Here you can find the tool already compiled](https://github.com/lucasepe/crumbs/releases/latest) for:
- MacOS
- Linux
- Windows
---
# CHANGE LOG
👉 [Record of all notable changes made to a project](./CHANGELOG.md)