{ "info": { "author": "Peter Volf", "author_email": "do.volfp@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Natural Language :: English", "Operating System :: OS Independent", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7", "Programming Language :: Python :: 3.8", "Programming Language :: Python :: 3 :: Only", "Topic :: Internet :: WWW/HTTP :: Dynamic Content", "Topic :: Software Development :: Code Generators", "Topic :: Software Development :: Libraries :: Python Modules", "Topic :: Text Processing :: Markup :: HTML", "Topic :: Utilities", "Typing :: Typed" ], "description": "[![Build Status](https://travis-ci.org/volfpeter/markyp-highlightjs.svg?branch=master)](https://travis-ci.org/volfpeter/markyp-highlightjs)\n[![Downloads](https://pepy.tech/badge/markyp-highlightjs)](https://pepy.tech/project/markyp-highlightjs)\n[![Downloads](https://pepy.tech/badge/markyp-highlightjs/month)](https://pepy.tech/project/markyp-highlightjs/month)\n[![Downloads](https://pepy.tech/badge/markyp-highlightjs/week)](https://pepy.tech/project/markyp-highlightjs/week)\n\n# markyp-highlightjs\n\nHighlight.js-based syntax highlighting for web pages built with [markyp-html](https://github.com/volfpeter/markyp-html).\n\n## Installation\n\nThe project is listed on the Python Package Index, it can be installed simply by executing `pip install markyp-highlightjs`.\n\n## Getting started\n\nIf you are not familiar with the basic concepts of `markyp`, please start by having a look at its documentation [here](https://github.com/volfpeter/markyp).\n\nThe following code shows the creation of a simple webpage that displays syntax highlighted Python code. There are three things to note in the example:\n\n- The selected theme (CSS) is added to the head of the document.\n- The syntax highlighted code is created using the `highlight()` method.\n- The JavaScript code that imports and initializes Highlight.js is added to the `javascript` section of the page.\n\n```Python\nfrom markyp_html import webpage\nfrom markyp_highlightjs import js, themes, highlight\n\ncode = \"\\n\".join([\n \"from markyp_html import webpage\",\n \"from markyp_highlightjs import js, themes, highlight\",\n \"page = webpage(\",\n \" highlight(\\\"import antigravity\\\", language=\\\"python\\\"),\",\n \" page_title=\\\"markyp-highlightjs demo page\\\",\",\n \" head_elements=[themes.darcula],\",\n \" javascript=js.js\",\n \")\",\n \"\",\n \"print(page)\"\n])\n\npage = webpage(\n highlight(code, language=\"python\"),\n page_title=\"markyp-highlightjs demo page\",\n head_elements=[themes.github],\n javascript=js.js\n)\n\nprint(page)\n```\n\nFor more details on how this package works, please see [markyp](https://github.com/volfpeter/markyp) and [markyp-html](https://github.com/volfpeter/markyp-html).\n\n## Community guidelines\n\nIn general, please treat each other with respect and follow the below guidelines to interact with the project:\n\n- _Questions, feedback_: Open an issue with a `[Question] ` title.\n- _Bug reports_: Open an issue with a `[Bug] ` title, an adequate description of the bug, and a code snippet that reproduces the issue if possible.\n- _Feature requests and ideas_: Open an issue with an `[Enhancement] ` title and a clear description of the enhancement proposal.\n\n## Contribution guidelines\n\nEvery form of contribution is welcome, including documentation improvements, tests, bug fixes, and feature implementations.\n\nPlease follow these guidelines to contribute to the project:\n\n- Make sure your changes match the documentation and coding style of the project, including [PEP 484](https://www.python.org/dev/peps/pep-0484/) type annotations.\n- `mypy` is used to type-check the codebase, submitted code should not produce typing errors. See [this page](http://mypy-lang.org/) for more information on `mypy`.\n- _Small_ fixes can be submitted simply by creating a pull request.\n- Non-trivial changes should have an associated [issue](#community-guidelines) in the issue tracker that commits must reference (typically by adding `#refs ` to the end of commit messages).\n- Please write [tests](#testing) for the changes you make (if applicable).\n\nIf you have any questions about contributing to the project, please contact the project owner.\n\nAs mentioned in the [contribution guidelines](#contribution-guidelines), the project is type-checked using `mypy`, so first of all, the project must pass `mypy`'s static code analysis.\n\nThe project is tested using `pytest`. The chosen test layout is that tests are outside the application code, see [this page](https://docs.pytest.org/en/latest/goodpractices.html#tests-outside-application-code) for details on what it means in practice.\n\nIf `pytest` is installed, the test set can be executed using the `pytest test` command from within the project directory.\n\nIf `pytest-cov` is also installed, a test coverage report can be generated by executing `pytest test --cov markyp_highlightjs` from the root directory of the project.\n\n## License - MIT\n\nThe library is open-sourced under the conditions of the MIT [license](https://choosealicense.com/licenses/mit/).\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/volfpeter/markyp-highlightjs", "keywords": "html markup generator utility syntax code highlighting", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "markyp-highlightjs", "package_url": "https://pypi.org/project/markyp-highlightjs/", "platform": "", "project_url": "https://pypi.org/project/markyp-highlightjs/", "project_urls": { "Homepage": "https://github.com/volfpeter/markyp-highlightjs" }, "release_url": "https://pypi.org/project/markyp-highlightjs/0.1910.0/", "requires_dist": [ "markyp-html (>=0.1910)", "markyp (>=0.1910)" ], "requires_python": ">=3.6", "summary": "Highlight.js-based syntax highlighting for web pages built with markyp-html", "version": "0.1910.0" }, "last_serial": 5972585, "releases": { "0.1904.0": [ { "comment_text": "", "digests": { "md5": "6e06ab5cb4d1d7a3183e70a83917b557", "sha256": "d28e0534e0e9eb013a69935d8e17490e326a211a51c8cd74f7986678f20f6e8c" }, "downloads": -1, "filename": "markyp_highlightjs-0.1904.0-py3-none-any.whl", "has_sig": false, "md5_digest": "6e06ab5cb4d1d7a3183e70a83917b557", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6", "size": 5412, "upload_time": "2019-04-15T20:38:50", "url": "https://files.pythonhosted.org/packages/70/70/b59c35d9062ed66d02b24da8d530f681437b4c3c9dbd9380b2396d8ed6a5/markyp_highlightjs-0.1904.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "1c7579c781f4d2d05d8bf14e23e22206", "sha256": "ba4771824e8b03bd086451178a60dc1dd11acb78a6100f2c61702219bf7a2d84" }, "downloads": -1, "filename": "markyp-highlightjs-0.1904.0.tar.gz", "has_sig": false, "md5_digest": "1c7579c781f4d2d05d8bf14e23e22206", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 5277, "upload_time": "2019-04-15T20:38:52", "url": "https://files.pythonhosted.org/packages/a9/62/b9e5ca62f27384975892e670161d29b3d613480a2e59efe02d8432bd636a/markyp-highlightjs-0.1904.0.tar.gz" } ], "0.1905.0": [ { "comment_text": "", "digests": { "md5": "2b92d5b8486a996fd19e17b8678643b3", "sha256": "efea97b95a13751fdfb21672223dcbf7e0d7098ca627cee7a4fe293bd4b638ba" }, "downloads": -1, "filename": "markyp_highlightjs-0.1905.0-py3-none-any.whl", "has_sig": false, "md5_digest": "2b92d5b8486a996fd19e17b8678643b3", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6", "size": 5886, "upload_time": "2019-05-06T21:16:17", "url": "https://files.pythonhosted.org/packages/18/61/f3cc3b81e8044734f8be90e2b9c45b5d4b35aa1985c5bd1304993596dc9c/markyp_highlightjs-0.1905.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "6f5017718c7aa71a6a28a2a06a5db789", "sha256": "8b8146ec574ad6f8db708397bf25a63f4532a1e395dfd10dd35ba764c8497e34" }, "downloads": -1, "filename": "markyp-highlightjs-0.1905.0.tar.gz", "has_sig": false, "md5_digest": "6f5017718c7aa71a6a28a2a06a5db789", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 6019, "upload_time": "2019-05-06T21:16:18", "url": "https://files.pythonhosted.org/packages/85/33/caec16a60a4fd7046a59c5b4716b52a5501342b08d2b2cd96477e30d28fd/markyp-highlightjs-0.1905.0.tar.gz" } ], "0.1906.0": [ { "comment_text": "", "digests": { "md5": "81b5e41c70e6cbd7f03f18ead3b41ba4", "sha256": "338ddce875a55443d94c26ac933cac8fef23fe9232b08513f4733ef801d79511" }, "downloads": -1, "filename": "markyp_highlightjs-0.1906.0-py3-none-any.whl", "has_sig": false, "md5_digest": "81b5e41c70e6cbd7f03f18ead3b41ba4", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6", "size": 5945, "upload_time": "2019-06-08T07:41:08", "url": "https://files.pythonhosted.org/packages/0a/8f/a04c4c34b24827009c9b72c6ffe704319b144459b112772fb5f75e426dd6/markyp_highlightjs-0.1906.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "f8420543b3e021618b4288f4d94907e1", "sha256": "11862d22c3c3d62aae6b323a3c3e87a8f8d7c446fd2c7e3fbc3f8c279f3ea253" }, "downloads": -1, "filename": "markyp-highlightjs-0.1906.0.tar.gz", "has_sig": false, "md5_digest": "f8420543b3e021618b4288f4d94907e1", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 6083, "upload_time": "2019-06-08T07:41:10", "url": "https://files.pythonhosted.org/packages/be/ff/8ea6ce0d5b1e5dd32aa38a1b12705d1ac8f54312e6df926856065189dada/markyp-highlightjs-0.1906.0.tar.gz" } ], "0.1910.0": [ { "comment_text": "", "digests": { "md5": "09fce59ee397663023a5c7ea3f6f5e4f", "sha256": "24e098d7d095a025a2d7bd975c406ab51b3421dfd37fe5b911924126a7033e43" }, "downloads": -1, "filename": "markyp_highlightjs-0.1910.0-py3-none-any.whl", "has_sig": false, "md5_digest": "09fce59ee397663023a5c7ea3f6f5e4f", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6", "size": 5988, "upload_time": "2019-10-14T17:56:01", "url": "https://files.pythonhosted.org/packages/30/be/2f8d757a2b52f4321384acf1e27ae3634abb95bde7f2c4d753e4b4189cda/markyp_highlightjs-0.1910.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "85c00711e3533769fbb4af8ccd47790e", "sha256": "0fd70f73e7b5cd85449909e51424e31cab9e3dfd6ebef1e36ad415b42a633755" }, "downloads": -1, "filename": "markyp-highlightjs-0.1910.0.tar.gz", "has_sig": false, "md5_digest": "85c00711e3533769fbb4af8ccd47790e", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 6133, "upload_time": "2019-10-14T17:56:03", "url": "https://files.pythonhosted.org/packages/1c/7f/6edd49a9fd47cae30067162e67e8161100b06754679956f26d63f605828a/markyp-highlightjs-0.1910.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "09fce59ee397663023a5c7ea3f6f5e4f", "sha256": "24e098d7d095a025a2d7bd975c406ab51b3421dfd37fe5b911924126a7033e43" }, "downloads": -1, "filename": "markyp_highlightjs-0.1910.0-py3-none-any.whl", "has_sig": false, "md5_digest": "09fce59ee397663023a5c7ea3f6f5e4f", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6", "size": 5988, "upload_time": "2019-10-14T17:56:01", "url": "https://files.pythonhosted.org/packages/30/be/2f8d757a2b52f4321384acf1e27ae3634abb95bde7f2c4d753e4b4189cda/markyp_highlightjs-0.1910.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "85c00711e3533769fbb4af8ccd47790e", "sha256": "0fd70f73e7b5cd85449909e51424e31cab9e3dfd6ebef1e36ad415b42a633755" }, "downloads": -1, "filename": "markyp-highlightjs-0.1910.0.tar.gz", "has_sig": false, "md5_digest": "85c00711e3533769fbb4af8ccd47790e", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 6133, "upload_time": "2019-10-14T17:56:03", "url": "https://files.pythonhosted.org/packages/1c/7f/6edd49a9fd47cae30067162e67e8161100b06754679956f26d63f605828a/markyp-highlightjs-0.1910.0.tar.gz" } ] }