Skip to main content

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

see sample a test.html result

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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for mkdocs-wavedrom-plugin, version 0.1.0
Filename, size File type Python version Upload date Hashes
Filename, size mkdocs_wavedrom_plugin-0.1.0-py3-none-any.whl (9.0 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size mkdocs-wavedrom-plugin-0.1.0.tar.gz (3.0 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page