A MkDocs plugin for support wavedrom charts in markdown file
Project description
This is a mkdocs plugin, this could enable the wavedrom charts in the markdown file.Please follow the 'how to' section in reame to enable this plugin
mkdocs-wavedrom-plugin
A MkDocs plugin,
render waveform charts in the wavedrom style.
Installation
Install the package with pip (under progress):
pip install git+https://github.com/mkdocs-mkdocs-plugin
How to use
More information about plugins in the MkDocs documentation
write markdown/wavedrom code
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.
setup mkdocs.yml
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/wavedrom@2.1.2/wavedrom.unpkg.js
# - https://wavedrom.com/skins/default.js
Demo
local
$ python -m venv env
$ ./env/bin/python setup.py install
$ ./env/bin/mkdocs build
$ ./env/bin/mkdocs serve &
$ browse http://localhost:8000/test/index.html
or make build
and browse site/test/index.html
, if you have make binary.
Thanks
a lot part of this plugin
were came from mkdocs-mermaid-plugin
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for mkdocs-wavedrom-plugin-0.1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | bf28b854de615256d05eda010e85241936266aa41d301811b5a821c322bbf7e0 |
|
MD5 | 2851e1317eef643e7ca705e926c47aa6 |
|
BLAKE2b-256 | 931bbb0c2976be62ee52b09160a4d7947aa32d554061b06209f4484fc1ce3083 |
Hashes for mkdocs_wavedrom_plugin-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a7588e838733bf4f343440bb7b9ee9c512e7d2c054dba61c4ae081cde898b266 |
|
MD5 | 9c4dac771cdf00e64578ece634a0f4a5 |
|
BLAKE2b-256 | b613694e44296433d002df24a057932b4b41fa26d81324cc13f2587fa731a0bc |