wyozi/latex-mindmapper

Create mindmaps from .tex source files

latex-mindmapper

latex-mindmapper is a binary that parses .tex files for special \lmmnode commands and uses those to create a DOT graph description. The goal is to allow building a mindmap inside the LaTeX file to make it easier to keep it up to date.

Usage

1. Add the following no-op command to your .tex file, so that \lmmnode will not throw any errors: \newcommand{\lmmnode}[4][]{}
2. Insert \lmmnode commands into your .tex file
   • Syntax: \lmmnode{<parent_id>}{<id>}{<label>}
   • (example) root node: \lmmnode{}{root}{Root node}
   • (example) branch: \lmmnode{root}{branch1}{Branch}
3. Run latex-mindmapper my-article.tex to print DOT description of the file to stdout.

Examples

Print examples/foo.tex mindmap to output.png using Graphviz:

cargo run -- examples/foo.tex | dot -Tpng > output.png

Produces

Github action

Latex-mindmapper can be used as a Github action step:

on: [push]

jobs:
  create_mindmap:
    runs-on: ubuntu-latest
    steps:
    - name: Checkout repository
      uses: actions/checkout@v1
    - name: Create mindmap
      uses: wyozi/latex-mindmapper@master
      with:
        filename: 'main.tex'
    - name: Install graphviz
      run: sudo apt update && sudo apt install graphviz
    - name: Create mindmap
      run: dot -Tpng mindmap.dot > mindmap.png
    - name: Archive created mindmap
      uses: actions/upload-artifact@v1
      with:
        name: mindmap.png
        path: mindmap.png