{
    "info": {
        "author": "Rousseau Alexandre",
        "author_email": "rousseaualexandre.lyon@gmail.com",
        "bugtrack_url": null,
        "classifiers": [
            "Development Status :: 4 - Beta",
            "License :: OSI Approved :: MIT License",
            "Natural Language :: English",
            "Operating System :: Microsoft :: Windows :: Windows 7",
            "Programming Language :: Python",
            "Programming Language :: Python :: 3.4",
            "Topic :: Communications",
            "Topic :: Internet :: WWW/HTTP :: Site Management",
            "Topic :: Software Development :: Documentation",
            "Topic :: Software Development :: Libraries :: Python Modules",
            "Topic :: Text Processing :: Filters",
            "Topic :: Text Processing :: Markup :: HTML"
        ],
        "description": "Super-Markdown\n==============\n\na Python library to export a complex Markdown file into a standalone HTML file.\n\n\nIt will include:\n\n* [Mermaid.js][mermaid.js] to create diagrams with javascript\n* [graphviz][graphviz] to create Diagrams in [Dot language][Dot language]\n* [Markdown-TOC][TOC] to create Table of Content\n* [markdown-checklist][markdown-checklist] to support create Checklists\n* [Github Flavoured MarkdownStylesheet][GFM]\n\n\nInstalation\n-----------\n\n### Old School\n\n```bash\ngit clone https://github.com/madeindjs/super-markdown.git\ncd super-markdown\npython setup.py install\n```\n\n\n### New School\n\n```bash\npip install supermarkdown\n```\n\n\nUsage\n-----\n\n### Command line usage\n\n* export **one** markdown file in **one** Html file\n\n```bash\nsuper-markdown -f README.md\n```\n\n\n* export **many** markdown files in **one** Html file\n\n```bash\nsuper-markdown -d /home/alex/markdown_files/\n```\n\n#### additional options\n\n* Choose the name of the output file\n\n```bash\nsuper-markdown -d /home/alex/markdown_files/ -o my_concatenated_file.html\n```\n\n* Prevent the browser from opening\n\n```bash\nsuper-markdown -d /home/alex/markdown_files/ -no_browser\n```\n\n\n\n### API usage\n\n#### Hello World\n\n```Python\nfrom SuperMarkdown import SuperMarkdown\n\nsupermd = SuperMarkdown()\ncontent = \"# Hello World\\r\\n\"\ncontent += \"[SuperMarkdown](https://github.com/madeindjs/Super-Markdown) is awesome!\"\n\nsupermd.add_content(text=content)\n\nsupermd.export()\n```\n\n```Python\n# Additional options\n\nsupermd.export_url = 'my_export_url.html'  # to change the export filename\nsupermd.open_browser = False  # to deactivate browser opening\n```\n\n#### Add [Table of Content][TOC]\n\n```Python\nsupermd.add_TOC(text=content)\ncontent = \"## Other title\\r\\n## Other title\\r\\n###sutitle\\r\\n## Other title\"\nsupermd.add_content(text=content)\nsupermd.export()\n```\n\n\n\n\n#### Add [Dot Graph][Dot language]\n\n```Python\ndotgraph = \"\"\"```dotgraph\n    digraph \"pet-shop\" {\n        graph [rankdir=LR]\n        node [shape=plaintext]\n        edge [arrowhead=vee arrowsize=2]\n        parrot\n        dead\n        parrot -> dead\n    }\n    ```\"\"\"\nsupermd.add_content(text=dotgraph)\nsupermd.export()\n```\n\n\n\n\n#### Convert markdown file(s)\n\n##### one file\n\n```Python\nsupermd = SuperMarkdown()\nsupermd.add_content('/home/alex/markdown_files/a_file.md')\nsupermd.export()\n```\n\n\n##### many files\n\n```Python\nfiles = os.listdir('/home/alex/markdown_files/')\nsupermd = SuperMarkdown()\nsupermd.add_content(*files)\nsupermd.export()\n```\n\n\nSyntax\n------\n\n### Table of content\n\nTo create a [Table of content][TOC] you just need to insert `[TOC]`\nin your markdown file\n\n\n### Markdown\n\n[Markdown-Cheatsheet](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet)\n\n\n### Mermaid.js\n\n[Mermaid.js Basic Syntax](https://knsv.github.io/mermaid/#flowcharts-basic-syntax)\n\n\n### Dot Language\n\n[Dot Language Cheatsheet](http://www.graphviz.org/content/dot-language)\n\n\nRequirements\n------------\n\nFirst you need to install [graphviz](http://www.graphviz.org/Download..php) on\nyour computer\n\nThen you need to install these python librairy\n\n* [Python-Markdown][Python-Markdown]\n* [markdown-checklist][Python-Markdown]\n* [graphviz][graphviz]\n* [beautifulsoup4](https://pypi.python.org/pypi/beautifulsoup4)\n\nYou can do it quickly with this command `pip install -r requirements.txt`\n\n\nAuthor\n------\n\n[Rousseau Alexandre][madeindjs]\n\nContributors\n------------\n\n* [Vifespoir](https://github.com/Vifespoir)\n\nLicense\n-------\n\n[MIT](https://opensource.org/licenses/MIT)\n\n\n[super-markdown]: https://github.com/madeindjs/Super-Markdown.git\n\n[Python-Markdown]: https://pythonhosted.org/Markdown/\n[graphviz]: https://pypi.python.org/pypi/graphviz\n[TOC]: https://pythonhosted.org/Markdown/extensions/toc.html\n[markdown-checklist]: https://github.com/FND/markdown-checklist\n[mermaid.js]: https://github.com/knsv/mermaid\n[GFM]: https://gist.github.com/andyferra/2554919\n[Dot language]: https://en.wikipedia.org/wiki/DOT_(graph_description_language)\n\n[madeindjs]: https://github.com/madeindjs/\n",
        "description_content_type": null,
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/madeindjs/Super-Markdown",
        "keywords": "",
        "license": "",
        "maintainer": "",
        "maintainer_email": "",
        "name": "SuperMarkdown",
        "package_url": "https://pypi.org/project/SuperMarkdown/",
        "platform": "",
        "project_url": "https://pypi.org/project/SuperMarkdown/",
        "project_urls": {
            "Homepage": "https://github.com/madeindjs/Super-Markdown"
        },
        "release_url": "https://pypi.org/project/SuperMarkdown/0.2.4/",
        "requires_dist": null,
        "requires_python": "",
        "summary": "export a complex Markdown file into a standalone HTML file.",
        "version": "0.2.4"
    },
    "last_serial": 3184799,
    "releases": {
        "0.2.0": [],
        "0.2.2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "64b158c53727ad2e14aa817a1898f53e",
                    "sha256": "3bc248ef39f90b9259c0831c784a8ca02059bcb5c4f956cc8398737f81d936e5"
                },
                "downloads": -1,
                "filename": "SuperMarkdown-0.2.2.zip",
                "has_sig": false,
                "md5_digest": "64b158c53727ad2e14aa817a1898f53e",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 248379,
                "upload_time": "2016-07-29T07:46:17",
                "url": "https://files.pythonhosted.org/packages/e5/a3/2d2d224820c3ad2bcd9c4023c38762dd92d7d38890bc882f543356001a68/SuperMarkdown-0.2.2.zip"
            }
        ],
        "0.2.3": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "ec97dbe4a4f47a05d2b65e1b2bafd389",
                    "sha256": "15a79e099e1c56ed583dedc5e49820d5f6a50f55a6dac76e2de03d2033a10d86"
                },
                "downloads": -1,
                "filename": "SuperMarkdown-0.2.3.tar.gz",
                "has_sig": false,
                "md5_digest": "ec97dbe4a4f47a05d2b65e1b2bafd389",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 243497,
                "upload_time": "2016-12-08T15:09:33",
                "url": "https://files.pythonhosted.org/packages/df/86/bff8e5793f3acc0c5be01a08d91b1b2a9443da1e0f44b7b71afba87cf518/SuperMarkdown-0.2.3.tar.gz"
            }
        ],
        "0.2.4": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "3ceecd0f521aa21a604b028acea519c7",
                    "sha256": "ef521df370d6a374252d6578cc3a76264cce66530fb5f5375af31ac8f7665121"
                },
                "downloads": -1,
                "filename": "SuperMarkdown-0.2.4.tar.gz",
                "has_sig": false,
                "md5_digest": "3ceecd0f521aa21a604b028acea519c7",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 243975,
                "upload_time": "2017-09-19T08:45:09",
                "url": "https://files.pythonhosted.org/packages/49/a6/01b0af12bad1cd71b540a133f4c832d2bf577c839567415dfd4436072a1c/SuperMarkdown-0.2.4.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "3ceecd0f521aa21a604b028acea519c7",
                "sha256": "ef521df370d6a374252d6578cc3a76264cce66530fb5f5375af31ac8f7665121"
            },
            "downloads": -1,
            "filename": "SuperMarkdown-0.2.4.tar.gz",
            "has_sig": false,
            "md5_digest": "3ceecd0f521aa21a604b028acea519c7",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 243975,
            "upload_time": "2017-09-19T08:45:09",
            "url": "https://files.pythonhosted.org/packages/49/a6/01b0af12bad1cd71b540a133f4c832d2bf577c839567415dfd4436072a1c/SuperMarkdown-0.2.4.tar.gz"
        }
    ]
}