{
"info": {
"author": "Daniil Minukhin",
"author_email": "ddddsa@gmail.com",
"bugtrack_url": null,
"classifiers": [
"Development Status :: 5 - Production/Stable",
"Environment :: Console",
"Intended Audience :: Developers",
"License :: OSI Approved :: MIT License",
"Operating System :: OS Independent",
"Programming Language :: Python",
"Topic :: Documentation",
"Topic :: Utilities"
],
"description": "\n\n# Mermaid Diagrams Preprocessor for Foliant\n\n[Mermaid](https://mermaidjs.github.io/) is an open source diagram visualization tool. This preprocessor converts Mermaid diagram definitions in your Markdown files into images on the fly during project build.\n\n## Installation\n\n```bash\n$ pip install foliantcontrib.mermaid\n```\n\nPlease note that to use this preprocessor you will also need to install Mermaid and Mermaid CLI:\n\n```bash\n$ npm install mermaid # installs locally\n$ npm install mermaid.cli\n```\n\n## Config\n\nTo enable the preprocessor, add `mermaid` to `preprocessors` section in the project config:\n\n```yaml\npreprocessors:\n - mermaid\n```\n\nThe preprocessor has a number of options:\n\n```yaml\npreprocessors:\n - mermaid:\n cache_dir: !path .diagramscache\n mermaid_path: !path node_modules/.bin/mmdc\n format: svg\n params:\n ...\n```\n\n`cache_dir`\n: Path to the directory with the generated diagrams. It can be a path relative to the project root or a global one; you can use `~/` shortcut.\n\n> To save time during build, only new and modified diagrams are rendered. The generated images are cached and reused in future builds.\n\n`mermaid_path`\n: Path to Mermaid CLI binary. If you installed Mermaid locally this parameter is required. Default: `mmdc`.\n\n`format`\n: Generated image format. Available: `svg`, `png`, `pdf`. Default `svg`.\n\n`params`\n: Params passed to the image generation command:\n\n preprocessors:\n - mermaid:\n params:\n theme: forest\n\n> To see the full list of available params, run `mmdc -h` or check [here](https://github.com/mermaidjs/mermaid.cli#options).\n\n## Usage\n\nTo insert a diagram definition in your Markdown source, enclose it between `...` tags:\n\n```markdown\nHere\u2019s a diagram:\n\n\ngraph TD;\n A-->B;\n\n```\n\nYou can set any parameters in the tag options. Tag options have priority over the config options so you can override some values for specific diagrams while having the default ones set up in the config.\n\nTags also have an exclusive option `caption` \u2014 the markdown caption of the diagram image.\n\n```markdown\nDiagram with a caption:\n\n\n\n```\n\n> Note that command params listed in the `params` option are stated in YAML format. Remember that YAML is sensitive to indentation so for several params it is more suitable to use JSON-like mappings: `{key1: 1, key2: 'value2'}`.\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/foliant-docs/foliantcontrib.mermaid",
"keywords": "",
"license": "MIT",
"maintainer": "",
"maintainer_email": "",
"name": "foliantcontrib.mermaid",
"package_url": "https://pypi.org/project/foliantcontrib.mermaid/",
"platform": "any",
"project_url": "https://pypi.org/project/foliantcontrib.mermaid/",
"project_urls": {
"Homepage": "https://github.com/foliant-docs/foliantcontrib.mermaid"
},
"release_url": "https://pypi.org/project/foliantcontrib.mermaid/1.0.1/",
"requires_dist": [
"foliant (>=1.0.8)",
"foliantcontrib.utils.combined-options (>=1.0.1foliantcontrib.utils.preprocessor_ext>=1.0.0)"
],
"requires_python": "",
"summary": "Mermaid diagrams preprocessor for Foliant.",
"version": "1.0.1"
},
"last_serial": 5928015,
"releases": {
"1.0.0": [
{
"comment_text": "",
"digests": {
"md5": "6b61463ad95aa40b23ba084989bb1c35",
"sha256": "46c6634bd9d60353e9da7bcd07329eaed634118e33c6baaaf99f66511801e43a"
},
"downloads": -1,
"filename": "foliantcontrib.mermaid-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6b61463ad95aa40b23ba084989bb1c35",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 5424,
"upload_time": "2019-08-01T12:20:42",
"url": "https://files.pythonhosted.org/packages/98/a1/221a3db137413652fb976053e48d91d7c65984e3e0c1b45876f369044b19/foliantcontrib.mermaid-1.0.0-py3-none-any.whl"
},
{
"comment_text": "",
"digests": {
"md5": "dbc74f1793f3d2ccb5aaed5c2730df51",
"sha256": "9cd39c81837055b6a0f3e84393baedff6dcb8458321564e270f7f923bb87b445"
},
"downloads": -1,
"filename": "foliantcontrib.mermaid-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "dbc74f1793f3d2ccb5aaed5c2730df51",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 4421,
"upload_time": "2019-08-01T12:20:45",
"url": "https://files.pythonhosted.org/packages/f6/39/c76514bb49f8cb6e35a00369e42dffb98e2f1abc1e44876657eff5673ee7/foliantcontrib.mermaid-1.0.0.tar.gz"
}
],
"1.0.1": [
{
"comment_text": "",
"digests": {
"md5": "9de8e8c054b2992c50bca6fbf9bafa3d",
"sha256": "ed92f94fc598defc6d602133194456300cbe4be2c82e1c344242ffbdd0074427"
},
"downloads": -1,
"filename": "foliantcontrib.mermaid-1.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9de8e8c054b2992c50bca6fbf9bafa3d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 5492,
"upload_time": "2019-10-04T12:13:01",
"url": "https://files.pythonhosted.org/packages/85/30/931621316c5aa64dc78a0575fd5a4a4b449bda2b393bfa10db75cc5562a2/foliantcontrib.mermaid-1.0.1-py3-none-any.whl"
},
{
"comment_text": "",
"digests": {
"md5": "2ff91a0c4e1747cb1a19797979873c84",
"sha256": "c658a93d2ba436f750f8d4c6c1876b372aad18ac34be8869cb3aa058ac1ee677"
},
"downloads": -1,
"filename": "foliantcontrib.mermaid-1.0.1.tar.gz",
"has_sig": false,
"md5_digest": "2ff91a0c4e1747cb1a19797979873c84",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 4491,
"upload_time": "2019-10-04T12:13:03",
"url": "https://files.pythonhosted.org/packages/b9/a4/0a6f59014bc13a0782551607ccaa064940d68ed8c3b6053ace852d80d950/foliantcontrib.mermaid-1.0.1.tar.gz"
}
]
},
"urls": [
{
"comment_text": "",
"digests": {
"md5": "9de8e8c054b2992c50bca6fbf9bafa3d",
"sha256": "ed92f94fc598defc6d602133194456300cbe4be2c82e1c344242ffbdd0074427"
},
"downloads": -1,
"filename": "foliantcontrib.mermaid-1.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9de8e8c054b2992c50bca6fbf9bafa3d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 5492,
"upload_time": "2019-10-04T12:13:01",
"url": "https://files.pythonhosted.org/packages/85/30/931621316c5aa64dc78a0575fd5a4a4b449bda2b393bfa10db75cc5562a2/foliantcontrib.mermaid-1.0.1-py3-none-any.whl"
},
{
"comment_text": "",
"digests": {
"md5": "2ff91a0c4e1747cb1a19797979873c84",
"sha256": "c658a93d2ba436f750f8d4c6c1876b372aad18ac34be8869cb3aa058ac1ee677"
},
"downloads": -1,
"filename": "foliantcontrib.mermaid-1.0.1.tar.gz",
"has_sig": false,
"md5_digest": "2ff91a0c4e1747cb1a19797979873c84",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 4491,
"upload_time": "2019-10-04T12:13:03",
"url": "https://files.pythonhosted.org/packages/b9/a4/0a6f59014bc13a0782551607ccaa064940d68ed8c3b6053ace852d80d950/foliantcontrib.mermaid-1.0.1.tar.gz"
}
]
}