{ "info": { "author": "Shimoda", "author_email": "kuri65536@hotmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "Intended Audience :: Developers", "Intended Audience :: Information Technology", "License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)", "Programming Language :: Python :: 2", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7" ], "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\n\nmkdocs-wavedrom-plugin\n=========================================================\nA MkDocs plugin, \nrender waveform charts in the wavedrom style.\n\n\n\nInstallation\n--------------------------\nInstall this package with pip.\n\n### from PyPi\n```bash\npip install mkdocs-wavedrom-plugin\n```\n\n### from github\n```bash\npip install git+https://github.com/kuri65536/mkdocs-mkdocs-plugin\n```\n\n\n\nHow to use\n--------------------------\nMore information about plugins in the [MkDocs documentation][mkdocs-plugins]\n\n[mkdocs-plugins]: http://www.mkdocs.org/user-guide/plugins/\n\n\n### write markdown/wavedrom code\nembed your wavedrom code in markdown documents.\n\n
\n```wavedrom\n{ signal: [{ name: 'Alfa', wave: '01.zx=ud.23.45' }] }\n```\n\n\nor see [a sample markdown](https://github.com/kuri65536/mkdocs-wavedrom-plugin/docs/test.md)\nfor the sample.\n\n\n\n### setup mkdocs.yml\nchange mkdocs.yml to use this plugin.\n\n```\nsite_name: test\nplugins:\n - markdownwavedrom\n\nextra_javascript:\n # - wavedrom.unpkg.js\n # - skin-default.js\n # above, place *.js in docs directory, or below from internet.\n - https://cdn.jsdelivr.net/npm/wavedrom@2.1.2/wavedrom.unpkg.js\n - https://wavedrom.com/skins/default.js\n```\n\n\n\nDemo\n--------------------------\nsee [sample a test.html result](https://raw.githack.com/kuri65536/mkdocs-wavedrom-plugin/master/test.html)\n\n### image\n\n\n### from local\n\n```shell\n$ python -m venv env\n$ ./env/bin/python setup.py install\n$ ./env/bin/mkdocs build\n$ ./env/bin/mkdocs serve &\n$ browse http://localhost:8000/test/index.html\n```\n\nor `make build` and `browse site/test/index.html`, if you have make binary.\n\n### (optional) download wavedrom\nto download javascript files to local\n\n```shell\n$ make download\n```\n\n\n\nThanks\n--------------------------\na lot part of this plugin \nwere came from mkdocs-mermaid-plugin\n\n\n\n",
"description_content_type": "text/markdown",
"docs_url": null,
"download_url": "",
"downloads": {
"last_day": -1,
"last_month": -1,
"last_week": -1
},
"home_page": "https://github.com/kuri65536/mkdocs-wavedrom-plugin",
"keywords": "mkdocs python markdown wavedrom",
"license": "MPL2",
"maintainer": "",
"maintainer_email": "",
"name": "mkdocs-wavedrom-plugin",
"package_url": "https://pypi.org/project/mkdocs-wavedrom-plugin/",
"platform": "",
"project_url": "https://pypi.org/project/mkdocs-wavedrom-plugin/",
"project_urls": {
"Homepage": "https://github.com/kuri65536/mkdocs-wavedrom-plugin"
},
"release_url": "https://pypi.org/project/mkdocs-wavedrom-plugin/0.1.1/",
"requires_dist": [
"setuptools (>=18.5)",
"beautifulsoup4 (>=4.6.3)",
"mkdocs (>=1.0.4)",
"typing"
],
"requires_python": ">=2.7",
"summary": "A MkDocs plugin for support wavedrom charts in markdown file",
"version": "0.1.1"
},
"last_serial": 5469053,
"releases": {
"0.1.0": [
{
"comment_text": "",
"digests": {
"md5": "9c4dac771cdf00e64578ece634a0f4a5",
"sha256": "a7588e838733bf4f343440bb7b9ee9c512e7d2c054dba61c4ae081cde898b266"
},
"downloads": -1,
"filename": "mkdocs_wavedrom_plugin-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9c4dac771cdf00e64578ece634a0f4a5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=2.7",
"size": 8967,
"upload_time": "2019-06-27T23:55:19",
"url": "https://files.pythonhosted.org/packages/b6/13/694e44296433d002df24a057932b4b41fa26d81324cc13f2587fa731a0bc/mkdocs_wavedrom_plugin-0.1.0-py3-none-any.whl"
},
{
"comment_text": "",
"digests": {
"md5": "2851e1317eef643e7ca705e926c47aa6",
"sha256": "bf28b854de615256d05eda010e85241936266aa41d301811b5a821c322bbf7e0"
},
"downloads": -1,
"filename": "mkdocs-wavedrom-plugin-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "2851e1317eef643e7ca705e926c47aa6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=2.7",
"size": 2988,
"upload_time": "2019-06-27T23:55:21",
"url": "https://files.pythonhosted.org/packages/93/1b/bb0c2976be62ee52b09160a4d7947aa32d554061b06209f4484fc1ce3083/mkdocs-wavedrom-plugin-0.1.0.tar.gz"
}
],
"0.1.1": [
{
"comment_text": "",
"digests": {
"md5": "1d47484ba78b89e0f96c424cde82fc3e",
"sha256": "dc1ad1676314f07ab1cb988b265bc21f0a28b8590d72806dda395b580cb5e45e"
},
"downloads": -1,
"filename": "mkdocs_wavedrom_plugin-0.1.1-py2-none-any.whl",
"has_sig": false,
"md5_digest": "1d47484ba78b89e0f96c424cde82fc3e",
"packagetype": "bdist_wheel",
"python_version": "py2",
"requires_python": ">=2.7",
"size": 9088,
"upload_time": "2019-06-30T23:52:34",
"url": "https://files.pythonhosted.org/packages/3d/7b/90e4cfbf22e06c43c991b11133e256222ebb755eca98eb7cd30a48a59faa/mkdocs_wavedrom_plugin-0.1.1-py2-none-any.whl"
},
{
"comment_text": "",
"digests": {
"md5": "a11ff04d922929bcb1502811183c4c8b",
"sha256": "6fc5502c12a6367a52eba398af98f44d70cdfb271a4d181bda6b9f12d6426e2a"
},
"downloads": -1,
"filename": "mkdocs_wavedrom_plugin-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a11ff04d922929bcb1502811183c4c8b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=2.7",
"size": 9083,
"upload_time": "2019-06-30T23:52:36",
"url": "https://files.pythonhosted.org/packages/3a/32/e0240559bcf9bf73c29f321ee5e7aee195a6a7503e1bb9939ce95042ccf0/mkdocs_wavedrom_plugin-0.1.1-py3-none-any.whl"
},
{
"comment_text": "",
"digests": {
"md5": "48b7819beac6b037a0997ae03e1a8de4",
"sha256": "2662f42b2282ab1ed01c1173be0b4d56683a4e813d813b1e7eca99954beb6dac"
},
"downloads": -1,
"filename": "mkdocs-wavedrom-plugin-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "48b7819beac6b037a0997ae03e1a8de4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=2.7",
"size": 3214,
"upload_time": "2019-06-30T23:52:37",
"url": "https://files.pythonhosted.org/packages/44/f1/bd7709fcc233b1f2aa6e998366886d24788385264e27b8e2de7790eb94c1/mkdocs-wavedrom-plugin-0.1.1.tar.gz"
}
]
},
"urls": [
{
"comment_text": "",
"digests": {
"md5": "1d47484ba78b89e0f96c424cde82fc3e",
"sha256": "dc1ad1676314f07ab1cb988b265bc21f0a28b8590d72806dda395b580cb5e45e"
},
"downloads": -1,
"filename": "mkdocs_wavedrom_plugin-0.1.1-py2-none-any.whl",
"has_sig": false,
"md5_digest": "1d47484ba78b89e0f96c424cde82fc3e",
"packagetype": "bdist_wheel",
"python_version": "py2",
"requires_python": ">=2.7",
"size": 9088,
"upload_time": "2019-06-30T23:52:34",
"url": "https://files.pythonhosted.org/packages/3d/7b/90e4cfbf22e06c43c991b11133e256222ebb755eca98eb7cd30a48a59faa/mkdocs_wavedrom_plugin-0.1.1-py2-none-any.whl"
},
{
"comment_text": "",
"digests": {
"md5": "a11ff04d922929bcb1502811183c4c8b",
"sha256": "6fc5502c12a6367a52eba398af98f44d70cdfb271a4d181bda6b9f12d6426e2a"
},
"downloads": -1,
"filename": "mkdocs_wavedrom_plugin-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a11ff04d922929bcb1502811183c4c8b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=2.7",
"size": 9083,
"upload_time": "2019-06-30T23:52:36",
"url": "https://files.pythonhosted.org/packages/3a/32/e0240559bcf9bf73c29f321ee5e7aee195a6a7503e1bb9939ce95042ccf0/mkdocs_wavedrom_plugin-0.1.1-py3-none-any.whl"
},
{
"comment_text": "",
"digests": {
"md5": "48b7819beac6b037a0997ae03e1a8de4",
"sha256": "2662f42b2282ab1ed01c1173be0b4d56683a4e813d813b1e7eca99954beb6dac"
},
"downloads": -1,
"filename": "mkdocs-wavedrom-plugin-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "48b7819beac6b037a0997ae03e1a8de4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=2.7",
"size": 3214,
"upload_time": "2019-06-30T23:52:37",
"url": "https://files.pythonhosted.org/packages/44/f1/bd7709fcc233b1f2aa6e998366886d24788385264e27b8e2de7790eb94c1/mkdocs-wavedrom-plugin-0.1.1.tar.gz"
}
]
}