A MkDocs plugin,
render waveform charts in the wavedrom style.
Install this package with pip.
pip install mkdocs-wavedrom-pluginpip install git https://github.com/kuri65536/mkdocs-mkdocs-pluginMore information about plugins in the MkDocs documentation
embed your wavedrom code in markdown documents.
```wavedrom
{ signal: [{ name: 'Alfa', wave: '01.zx=ud.23.45' }] }
```
or see a sample markdown for the sample.
change mkdocs.yml to use this plugin.
site_name: test
plugins:
- markdownwavedrom
extra_javascript:
# - wavedrom.unpkg.js
# - skin-default.js
# above, place *.js in docs directory, or below from internet.
- https://cdn.jsdelivr.net/npm/[email protected]/wavedrom.unpkg.js
- https://wavedrom.com/skins/default.js
$ python -m venv env
$ ./env/bin/python setup.py install
$ ./env/bin/mkdocs build
$ ./env/bin/mkdocs serve &
$ browse http://localhost:8000/test/index.htmlor make build and browse site/test/index.html, if you have make binary.
to download javascript files to local
$ make downloada lot part of this plugin
were came from mkdocs-mermaid-plugin
If you are feel to nice for this software, please donation to my
- Bitcoin | 19AyoXxhm8nzgcxgbiXNPkiqNASfc999gJ |
- Ether | 0x3a822c36cd5184f9ff162c7a55709f3d6d861608 |
- or librapay, I'm glad from smaller (about $1)
