{ "info": { "author": "Chris Pyles", "author_email": "cpyles@berkeley.edu", "bugtrack_url": null, "classifiers": [ "License :: OSI Approved :: BSD License", "Operating System :: OS Independent", "Programming Language :: Python :: 3" ], "description": "# Markdown to HTML Converter\n\nThis is a converter from Markdown to HTML with advanced support for Markdown tables and GFM syntax highlighting. This package relies on `markdown2` for converting basic Markdown to HTML and `pygments` to support code to HTML conversion for syntax highlighting. The default (and, currently, only) theme for this package is Monokai.\n\nYou can find a sample of a site generated from this package at [https://mcautograder.chrispyles.io](https://mcautograder.chrispyles.io).\n\n## Installation\n\nThe converter is installed using pip:\n\n```\npip install md2html\n```\n\n## Usage\n\nThis package an executable that can be run from the command line:\n\n```\nmd2html ...\n```\n\nHere is the help entry for this package:\n\n```\nusage: md2html [-h] [-s SITE] [-n NAV] ...\n\nconvert Markdown to HTML\n\npositional arguments:\n files files to be converted to HTML\n\noptional arguments:\n -h, --help show this help message and exit\n -s SITE, --site-info SITE\n add metadata to the HTML files\n -n NAV, --nav NAV add a YAML file to use for navigation menu\n```\n\nRunning the converter will place HTML files in the same directory as your Markdown files, with the `.md` extension replaced with `.html`. The HTML files come with CSS in a `style` tag in the `head`.\n\n### Page Metadata\n\nIf you would like to add metadata to your page, including a navigation menu, do so by creating a YAML file containing this metadata and passing the file path to the `-s` flag, e.g.\n\n```\nmd2html -s meta.yml ...\n```\n\nThe structure of your YAML file should be:\n\n```yaml\ntitle: page title\nauthor: page author\ndescription: page description\nnavigation:\n nav_title: navigation menu title\n links:\n - title: link name\n url: HTML file path\n - title: ...\n url: ...\n ...\n```\n\nCurrently, the `title` must be set if you use this option. The converter does not yet support navigation submenus, so all links will be rendered as\n\n* [Link 1]()\n* [Link 2]()\n* [Link 3]()\n* etc.\n\n### Navigation Menu\n\nThe converter also supports adding only a navigation menu without page metadata. To do this, pass a YAML file to the `-n` flag. It should have the following structure:\n\n```yaml\nnav_title: navigation menu title\nlinks:\n - title: link name\n url: HTML file path\n - title: ...\n url: ...\n ...\n```\n\n## Changelog\n\n**v1.3.0:**\n\n* Added unit tests & Travis CI\n* Refactored `bin/md2html` so that parser code is in `md2html/__init__.py`\n\n**v1.2:**\n\n* Added YAML syntax highlighting\n\n**v1.1:**\n\n* Added docstrings for documentation\n* Moved some utils out of `md2html/converter.py`\n\n**v1.0:**\n\n* Changed to Boostrap CSS\n\n**v0.1:**\n\n* Initial release\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/chrispyles/markdown-to-html", "keywords": "", "license": "BSD-3-Clause", "maintainer": "", "maintainer_email": "", "name": "md2html", "package_url": "https://pypi.org/project/md2html/", "platform": "", "project_url": "https://pypi.org/project/md2html/", "project_urls": { "Homepage": "https://github.com/chrispyles/markdown-to-html" }, "release_url": "https://pypi.org/project/md2html/1.3.0/", "requires_dist": null, "requires_python": "", "summary": "MD to HTML converter", "version": "1.3.0" }, "last_serial": 5925792, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "56ce484a0440f6260cf956313d4f1c78", "sha256": "e2658d2880609fc3367df3b5184893945f3977a0c76c30bba9db7e086c4ddaf5" }, "downloads": -1, "filename": "md2html-0.1.0-py3-none-any.whl", "has_sig": false, "md5_digest": "56ce484a0440f6260cf956313d4f1c78", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 9701, "upload_time": "2019-08-22T19:17:51", "url": "https://files.pythonhosted.org/packages/b9/52/5616c8804249c0876bdb0343dc0352da953f794d149a3f8dd68925fbe299/md2html-0.1.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "0664831f882528a00995e0d54c3c4229", "sha256": "97dbf512955ea88761fe465f4caaf77a4d68efc3626585595fe07f71ca825a70" }, "downloads": -1, "filename": "md2html-0.1.0.tar.gz", "has_sig": false, "md5_digest": "0664831f882528a00995e0d54c3c4229", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6248, "upload_time": "2019-08-22T19:17:53", "url": "https://files.pythonhosted.org/packages/b4/2e/ba45e1784e69f8cf98d669139c87afc24f5a1352375f06282b691caed165/md2html-0.1.0.tar.gz" } ], "1.0": [ { "comment_text": "", "digests": { "md5": "d78d08bea20878c95b50f6fac0db0624", "sha256": "46635fe165da45986950dd2da7bc2f49bea0120d56790e5bd9238a13c3f330c6" }, "downloads": -1, "filename": "md2html-1.0-py3-none-any.whl", "has_sig": false, "md5_digest": "d78d08bea20878c95b50f6fac0db0624", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 16511, "upload_time": "2019-08-29T23:30:28", "url": "https://files.pythonhosted.org/packages/34/cf/505ea03287da7446a7a9eab5c887822c007a2f0cd047ca3bafaa6786319c/md2html-1.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "da799dda6c79ea4dc1846db46884b07e", "sha256": "18598fdd04ab057827b07534a29b66d158bdd76a0b1976899e22406d861c323f" }, "downloads": -1, "filename": "md2html-1.0.tar.gz", "has_sig": false, "md5_digest": "da799dda6c79ea4dc1846db46884b07e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7099, "upload_time": "2019-08-29T23:30:30", "url": "https://files.pythonhosted.org/packages/fa/cc/1b3d2766dfa059836a89ba9d02d20190ecb58a7fd47e821bc5e8fb4565d3/md2html-1.0.tar.gz" } ], "1.1": [ { "comment_text": "", "digests": { "md5": "2fe19fa5a013ea846585ebcba5645ecf", "sha256": "a99d077f48be125dd17e037187ca89793e3b505dbb5158c3cf81aa7ef05a0892" }, "downloads": -1, "filename": "md2html-1.1-py3-none-any.whl", "has_sig": false, "md5_digest": "2fe19fa5a013ea846585ebcba5645ecf", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 17176, "upload_time": "2019-09-02T18:10:10", "url": "https://files.pythonhosted.org/packages/3b/32/c802620c20852da17583ba5999f4137ae2a24dc1b9a1ba4a350e024c09cf/md2html-1.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "ca612ee79d9fcc6389a3db5debe49f46", "sha256": "fe3f6e53411b8457fed997714f0297d6db0322861a4a5c1ac0d44309db3df499" }, "downloads": -1, "filename": "md2html-1.1.tar.gz", "has_sig": false, "md5_digest": "ca612ee79d9fcc6389a3db5debe49f46", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7220, "upload_time": "2019-09-02T18:10:12", "url": "https://files.pythonhosted.org/packages/9c/a6/d024c880fe0a75400f2e3eca8c1e54da2d3e3f7853c337e37656288e60d6/md2html-1.1.tar.gz" } ], "1.2": [ { "comment_text": "", "digests": { "md5": "0c353fecbeac15885076f43553c988c2", "sha256": "ce89c68fc18d5d3b9d6d164bcd94d712dbe5bce4a6c4a6ca72b7579671ef1912" }, "downloads": -1, "filename": "md2html-1.2-py3-none-any.whl", "has_sig": false, "md5_digest": "0c353fecbeac15885076f43553c988c2", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 17206, "upload_time": "2019-09-02T18:46:26", "url": "https://files.pythonhosted.org/packages/b7/42/7279306b6db7213a66a26284399d602fd39696c70b850ba4373a70be3ee1/md2html-1.2-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "4ad1dd23ef1099ce91a66cb894436b18", "sha256": "cf40a79bc832c7d500abcbbf7454e57ed016f0c4d68aeb7fadffd55372392de0" }, "downloads": -1, "filename": "md2html-1.2.tar.gz", "has_sig": false, "md5_digest": "4ad1dd23ef1099ce91a66cb894436b18", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7174, "upload_time": "2019-09-02T18:46:28", "url": "https://files.pythonhosted.org/packages/55/bb/22e22aab12b31a08b07c5a9a93cda83ac8ff43ca8f019ccd16e43e913e43/md2html-1.2.tar.gz" } ], "1.3.0": [ { "comment_text": "", "digests": { "md5": "fde968b6fd96dfd279dd0ec22a0d8bbb", "sha256": "65019dada0dcef59f35f68bbf72807c08b35773a037f3a15d5586ac25411803a" }, "downloads": -1, "filename": "md2html-1.3.0-py3-none-any.whl", "has_sig": false, "md5_digest": "fde968b6fd96dfd279dd0ec22a0d8bbb", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 18519, "upload_time": "2019-10-03T23:31:39", "url": "https://files.pythonhosted.org/packages/40/6f/ff37b5530c615cfc2b332dec13128cebe616ef511ca7e4b119f5593ba366/md2html-1.3.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "428cc90c18eb270a459d1293e6415ef7", "sha256": "f0cf6e6c7fcaddcf10eef13bd3f9d437ee699ca369ed7c52b3c914d9ed6dcb4e" }, "downloads": -1, "filename": "md2html-1.3.0.tar.gz", "has_sig": false, "md5_digest": "428cc90c18eb270a459d1293e6415ef7", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7979, "upload_time": "2019-10-03T23:31:40", "url": "https://files.pythonhosted.org/packages/1a/f1/afa5b5e194c2455df6b01bed1276b58112b05f7eb0bf8c0a9896ce9951b2/md2html-1.3.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "fde968b6fd96dfd279dd0ec22a0d8bbb", "sha256": "65019dada0dcef59f35f68bbf72807c08b35773a037f3a15d5586ac25411803a" }, "downloads": -1, "filename": "md2html-1.3.0-py3-none-any.whl", "has_sig": false, "md5_digest": "fde968b6fd96dfd279dd0ec22a0d8bbb", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 18519, "upload_time": "2019-10-03T23:31:39", "url": "https://files.pythonhosted.org/packages/40/6f/ff37b5530c615cfc2b332dec13128cebe616ef511ca7e4b119f5593ba366/md2html-1.3.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "428cc90c18eb270a459d1293e6415ef7", "sha256": "f0cf6e6c7fcaddcf10eef13bd3f9d437ee699ca369ed7c52b3c914d9ed6dcb4e" }, "downloads": -1, "filename": "md2html-1.3.0.tar.gz", "has_sig": false, "md5_digest": "428cc90c18eb270a459d1293e6415ef7", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7979, "upload_time": "2019-10-03T23:31:40", "url": "https://files.pythonhosted.org/packages/1a/f1/afa5b5e194c2455df6b01bed1276b58112b05f7eb0bf8c0a9896ce9951b2/md2html-1.3.0.tar.gz" } ] }