Metadata-Version: 2.1
Name: mkdocs-wavedrom-plugin
Version: 0.1.1
Summary: A MkDocs plugin for support wavedrom charts in markdown file
Home-page: https://github.com/kuri65536/mkdocs-wavedrom-plugin
Author: Shimoda
Author-email: kuri65536@hotmail.com
License: MPL2
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 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.
        
        <pre>
        ```wavedrom
        { signal: [{ name: 'Alfa', wave: '01.zx=ud.23.45' }] }
        ```
        </pre>
        
        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/wavedrom@2.1.2/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
        ![test image](https://user-images.githubusercontent.com/11357613/60380894-ad48c280-9a87-11e9-9e0a-e782b1805310.png)
        
        ### 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
        
        
Keywords: mkdocs python markdown wavedrom
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
Classifier: License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Requires-Python: >=2.7
Description-Content-Type: text/markdown
