yeongjun.kim wicksome

How to use PlantUML with Markdown

PlantUML is a really awesome way to create diagrams by writing code instead of drawing and dragging visual elements. Markdown is a really nice documentation tool.

Here's how I combine the two, to create docs with embedded diagrams.

Step 0: Setup

Get the command-line PlantUML from the download page or your relevant package manager.

There are 28 static site generators that support AsciiDoc sourcing.

public class Hello
{
   public static void Main()
   {
-      System.Console.WriteLine("Hello, World!");
+      System.Console.WriteLine("Rock all night long!");
   }
}

Aligning images

This is a guide for aligning images.

See the full Advanced Markdown doc for more tips and tricks

`left` alignment

GitHub Flavored Asciidoc (GFA)

Breadth First Search

Algorithm for searching graph-like data structures, one level at a time.

Step by Step

Start a queue
Check current node - if false, mark as visited, continue

Common Options

-#, --progress-bar Make curl display a simple progress bar instead of the more informational standard meter.

-b, --cookie <name=data> Supply cookie with request. If no =, then specifies the cookie file to use (see -c).

-c, --cookie-jar <file name> File to save response cookies to.

	// Variables used by Scriptable.
	// These must be at the very top of the file. Do not edit.
	// icon-color: deep-blue; icon-glyph: book; share-sheet-inputs: plain-text;
	// Stock Ticker Widget
	let stocksInfo = await getStockData()
	let widget = await createWidget()
	if (config.runsInWidget) {
	// The script runs inside a widget, so we pass our instance of ListWidget to be shown inside the widget on the Home Screen.
	Script.setWidget(widget)
	} else {

	#!/bin/bash
	if [ -f ~/Library/KeyBindings/DefaultkeyBinding.dict ]; then
	echo "~/Library/KeyBindings/DefaultkeyBinding.dict already exists"
	exit -1
	fi

	mkdir -p ~/Library/KeyBindings
	cat << EOF > ~/Library/KeyBindings/DefaultkeyBinding.dict
	{
	"₩" = ("insertText:", "\`");

	@startuml
	' uncomment the line below if you're using computer with a retina display
	' skinparam dpi 300
	!define Table(name,desc) class name as "desc" << (T,#FFAAAA) >>
	' we use bold for primary key
	' green color for unique
	' and underscore for not_null
	!define primary_key(x) <b>x</b>
	!define unique(x) <color:green>x</color>
	!define not_null(x) <u>x</u>