0.1.1 • Published 2 years ago
bitinfo v0.1.1
bitInfo
BitInfo will read a bitmap description and generate a SVG image to it.
It was designed specially to integrate with Markdown Preview Enhanced and its Code chunk feature.
Install
Easy way is to install it globally:
npm i -g bitinfoUsage
Markdown Preview Enhanced integrates lots of diagram generator. Since bitInfo is not one of them we must use code chunk feature to include it.
Simple add a fenced block and add a call to the bitinfo (change its path if not globally installed):
```bitinfo {cmd="bitinfo", args=["-i"] output="html" hide}
size 16
15 response =x "this is a response" #fdd
14..13 Func1,Func2 =00
highlight 14..13 "function selector"
7..0 =xxxxx10x
highlight 7..0 #88f "message ID"
10 Unicast
```Then use any of commands Run Code Chunk or Run All Code Chunk to generate diagrams.
bitInfo description tags
| tag | function | default |
|---|---|---|
| scale \ | diagram scale | 1 |
| size \ | registry size | 15..0 |
| bitGap \ | space between bits | 3 |
| nibbleGap \ | extra space between nibbles | 0 |
| byteGap \ | extra space between bytes | 6 |
| vertical | TODO | |
| default \ | default value for non declared bits | |
| background \ | can you guess? | white |
| highlight \ [color] ["legend"] | set color and legend for a range of bits | |
| \ [:names] [=values] ["descr"] [color] | define a bit range |
| type | pattern example |
|---|---|
| range | 1..16 or 15..0 (both ends are inclusive) |
| range | 24 (simplified form of 23..0) |
| num | integer or float |
| value | [01X?CZ] |
| color | #123 or orange (any css color can be named) |