Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kuri65536/mkdocs-wavedrom-plugin
A MkDocs plugin for support wavedrom charts in markdown file
https://github.com/kuri65536/mkdocs-wavedrom-plugin
Last synced: 3 months ago
JSON representation
A MkDocs plugin for support wavedrom charts in markdown file
- Host: GitHub
- URL: https://github.com/kuri65536/mkdocs-wavedrom-plugin
- Owner: kuri65536
- License: mpl-2.0
- Created: 2019-06-27T22:32:34.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2021-08-02T16:08:15.000Z (over 3 years ago)
- Last Synced: 2024-04-29T07:21:38.174Z (9 months ago)
- Language: Python
- Size: 13.7 KB
- Stars: 9
- Watchers: 0
- Forks: 4
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
mkdocs-wavedrom-plugin
=========================================================
A MkDocs plugin,
render waveform charts in the wavedrom style.
Installation
--------------------------
Install this package with pip.
### from PyPi
```bash
pip install mkdocs-wavedrom-plugin
```
### from github
```bash
pip install git+https://github.com/kuri65536/mkdocs-mkdocs-plugin
```
How to use
--------------------------
More information about plugins in the [MkDocs documentation][mkdocs-plugins]
[mkdocs-plugins]: http://www.mkdocs.org/user-guide/plugins/
### 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](https://github.com/kuri65536/mkdocs-wavedrom-plugin/docs/test.md)
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/[email protected]/wavedrom.unpkg.js
- https://wavedrom.com/skins/default.js
```
Demo
--------------------------
see [sample a test.html result](https://raw.githack.com/kuri65536/mkdocs-wavedrom-plugin/master/test.html)
### image
### from local
```shell
$ 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.
### (optional) download wavedrom
to download javascript files to local
```shell
$ make download
```
Thanks
--------------------------
a lot part of this plugin
were came from mkdocs-mermaid-plugin
Donations
---------------------
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)