blockdiagcontrib-octicons¶

A plugin for blockdiag that provides octicons as background/icon of nodes.

examples¶

blockdiagcontrib-octicons detects background and icon attributes starts with ‘octicon://’, and converts it as octicons .

Example:

blockdiag {
  plugin octicons;

  A [label = "", background = "octicon://mark-github"];
  B [icon = "octicon://cloud-upload?color=red"];
  A -> B;
}

see results at http://pythonhosted.org//blockdiagcontrib-octicons/

Requirements¶

blockdiag 1.4.3 or later

Copyright of octicons.ttf¶

License¶

Apache License 2.0

Note

octicons.ttf is licensed under SIL OFL 1.1 (http://scripts.sil.org/OFL)

Usage¶

At first, load octicons plugin with plugin statement. And then, you can use octicon:// URI to background and icon attributes:

blockdiag {
  plugin octicons;

  A [label = "", background = "octicon://mark-github"];
}

octicon:// URI accepts two options: size and color

color option changes color of octicon:

blockdiag {
  plugin octicons;

  A [label = "", background = "octicon://mark-github?color=red"];
}

size option changes size of octicon. you can choose from large, normal, small and pixels:

blockdiag {
  plugin octicons;

  A [label = "", background = "octicon://mark-github?size=large"];
  B [label = "", background = "octicon://mark-github?size=normal"];
  C [label = "", background = "octicon://mark-github?size=small"];
  D [label = "", background = "octicon://mark-github?size=8"];
}

name of octicons¶

octicon://code	octicon://log-out	octicon://trashcan
octicon://screen-full	octicon://graph	octicon://comment-discussion
octicon://repo-pull	octicon://file-media	octicon://terminal
octicon://gist-fork	octicon://color-mode	octicon://sign-out
octicon://repo-delete	octicon://stop	octicon://file-text
octicon://repo	octicon://hubot	octicon://cloud-download
octicon://gist-private	octicon://settings	octicon://git-pull-request
octicon://tag-add	octicon://microscope	octicon://x
octicon://chevron-down	octicon://mirror-public	octicon://search-save
octicon://arrow-down	octicon://arrow-small-right	octicon://sync
octicon://pulse	octicon://fold	octicon://comment-add
octicon://calendar	octicon://hourglass	octicon://chevron-left
octicon://clock	octicon://move-up	octicon://move-left
octicon://primitive-dot	octicon://person-follow	octicon://mark-github
octicon://key	octicon://file-binary	octicon://search
octicon://device-camera	octicon://credit-card	octicon://diff-removed
octicon://arrow-right	octicon://jersey	octicon://comment
octicon://primitive-square	octicon://markdown	octicon://unfold
octicon://heart	octicon://diff	octicon://tools
octicon://git-pull-request-abandoned	octicon://mail-read	octicon://eye
octicon://file-directory	octicon://beer	octicon://logo-github
octicon://three-bars	octicon://diff-modified	octicon://megaphone
octicon://pencil	octicon://file-directory-create	octicon://gist
octicon://tag-remove	octicon://list-ordered	octicon://git-branch
octicon://diff-ignored	octicon://ruby	octicon://gist-new
octicon://eye-unwatch	octicon://diff-added	octicon://repo-force-push
octicon://repo-clone	octicon://dashboard	octicon://history
octicon://alignment-unalign	octicon://circuit-board	octicon://lock
octicon://sign-in	octicon://tag	octicon://git-commit
octicon://file-symlink-file	octicon://triangle-right	octicon://clippy
octicon://repo-push	octicon://split	octicon://person-add
octicon://briefcase	octicon://repo-forked	octicon://alert
octicon://law	octicon://move-down	octicon://screen-normal
octicon://arrow-small-up	octicon://gist-secret	octicon://database
octicon://star-add	octicon://person	octicon://organization
octicon://rocket	octicon://mute	octicon://arrow-small-down
octicon://keyboard	octicon://file-symlink-directory	octicon://alignment-aligned-to
octicon://repo-create	octicon://device-camera-video	octicon://location
octicon://alignment-align	octicon://mail	octicon://move-right
octicon://diff-renamed	octicon://mention	octicon://milestone
octicon://file-submodule	octicon://jump-up	octicon://gift
octicon://server	octicon://steps	octicon://issue-opened
octicon://octoface	octicon://file-code	octicon://telescope
octicon://globe	octicon://triangle-left	octicon://arrow-left
octicon://mirror	octicon://home	octicon://git-branch-create
octicon://device-mobile	octicon://playback-pause	octicon://eye-watch
octicon://mirror-private	octicon://list-unordered	octicon://circle-slash
octicon://ellipsis	octicon://file-pdf	octicon://squirrel
octicon://git-compare	octicon://horizontal-rule	octicon://git-branch-delete
octicon://issue-closed	octicon://plug	octicon://git-merge
octicon://package	octicon://issue-reopened	octicon://jump-down
octicon://file-add	octicon://plus	octicon://mortar-board
octicon://rss	octicon://puzzle	octicon://inbox
octicon://jump-right	octicon://zap	octicon://bookmark
octicon://light-bulb	octicon://git-fork-private	octicon://question
octicon://triangle-up	octicon://link-external	octicon://file-zip
octicon://chevron-right	octicon://checklist	octicon://broadcast
octicon://playback-rewind	octicon://link	octicon://jump-left
octicon://mail-reply	octicon://bug	octicon://device-desktop
octicon://info	octicon://versions	octicon://unmute
octicon://flame	octicon://radio-tower	octicon://browser
octicon://arrow-up	octicon://pin	octicon://dash
octicon://check	octicon://gear	octicon://repo-sync
octicon://book	octicon://log-in	octicon://cloud-upload
octicon://triangle-down	octicon://playback-fast-forward	octicon://star
octicon://quote	octicon://podium	octicon://playback-play
octicon://remove-close	octicon://star-delete	octicon://arrow-small-left
octicon://paintcan	octicon://no-newline	octicon://chevron-up