Package: markyp-highlightjs
markyp-highlightjsHighlight.js-based syntax highlighting for web pages built withmarkyp-html.InstallationThe project is listed on the Python Package Index, it can be installed simply by executingpip install markyp-highlightjs.Getting startedIf you are not familiar with the basic concepts ofmarkyp, please start by having a look at its documentationhere.The following code shows the creation of a simple webpage that displays syntax highlighted Python code. There are three things to note in the example:The selected theme (CSS) is added to the head of the document.The syntax highlighted code is created using thehighlight()method.The JavaScript code that imports and initializes Highlight.js is added to thejavascriptsection of the page.frommarkyp_htmlimportwebpagefrommarkyp_highlightjsimportjs,themes,highlightcode="\n".join(["from markyp_html import webpage","from markyp_highlightjs import js, themes, highlight","page = webpage(","    highlight(\"import antigravity\", language=\"python\"),","    page_title=\"markyp-highlightjs demo page\",","    head_elements=[themes.darcula],","    javascript=js.js",")","","print(page)"])page=webpage(highlight(code,language="python"),page_title="markyp-highlightjs demo page",head_elements=[themes.github],javascript=js.js)print(page)For more details on how this package works, please seemarkypandmarkyp-html.Community guidelinesIn general, please treat each other with respect and follow the below guidelines to interact with the project:Questions, feedback: Open an issue with a[Question] <issue-title>title.Bug reports: Open an issue with a[Bug] <issue-title>title, an adequate description of the bug, and a code snippet that reproduces the issue if possible.Feature requests and ideas: Open an issue with an[Enhancement] <issue-title>title and a clear description of the enhancement proposal.Contribution guidelinesEvery form of contribution is welcome, including documentation improvements, tests, bug fixes, and feature implementations.Please follow these guidelines to contribute to the project:Make sure your changes match the documentation and coding style of the project, includingPEP 484type annotations.mypyis used to type-check the codebase, submitted code should not produce typing errors. Seethis pagefor more information onmypy.Smallfixes can be submitted simply by creating a pull request.Non-trivial changes should have an associatedissuein the issue tracker that commits must reference (typically by adding#refs <issue-id>to the end of commit messages).Please writetestsfor the changes you make (if applicable).If you have any questions about contributing to the project, please contact the project owner.As mentioned in thecontribution guidelines, the project is type-checked usingmypy, so first of all, the project must passmypy's static code analysis.The project is tested usingpytest. The chosen test layout is that tests are outside the application code, seethis pagefor details on what it means in practice.Ifpytestis installed, the test set can be executed using thepytest testcommand from within the project directory.Ifpytest-covis also installed, a test coverage report can be generated by executingpytest test --cov markyp_highlightjsfrom the root directory of the project.License - MITThe library is open-sourced under the conditions of the MITlicense.