https://github.com/volfpeter/markyp-highlightjs
HTML code highlighting markyp extension based on highlight.js
https://github.com/volfpeter/markyp-highlightjs
code-generator code-highlight html-css-javascript html5 markup
Last synced: 6 months ago
JSON representation
HTML code highlighting markyp extension based on highlight.js
- Host: GitHub
- URL: https://github.com/volfpeter/markyp-highlightjs
- Owner: volfpeter
- License: mit
- Created: 2019-03-10T09:38:23.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2025-05-05T13:13:08.000Z (8 months ago)
- Last Synced: 2025-05-05T14:30:06.879Z (8 months ago)
- Topics: code-generator, code-highlight, html-css-javascript, html5, markup
- Language: Python
- Size: 34.2 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://travis-ci.org/volfpeter/markyp-highlightjs)
[](https://pepy.tech/project/markyp-highlightjs)
[](https://pepy.tech/project/markyp-highlightjs/month)
[](https://pepy.tech/project/markyp-highlightjs/week)
# markyp-highlightjs
Highlight.js-based syntax highlighting for web pages built with [markyp-html](https://github.com/volfpeter/markyp-html).
## Installation
The project is listed on the Python Package Index, it can be installed simply by executing `pip install markyp-highlightjs`.
## Getting started
If 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).
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 the `highlight()` method.
- The JavaScript code that imports and initializes Highlight.js is added to the `javascript` section of the page.
```Python
from markyp_html import webpage
from markyp_highlightjs import js, themes, highlight
code = "\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 see [markyp](https://github.com/volfpeter/markyp) and [markyp-html](https://github.com/volfpeter/markyp-html).
## Community guidelines
In 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] ` title.
- _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.
- _Feature requests and ideas_: Open an issue with an `[Enhancement] ` title and a clear description of the enhancement proposal.
## Contribution guidelines
Every 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, including [PEP 484](https://www.python.org/dev/peps/pep-0484/) type annotations.
- `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`.
- _Small_ fixes can be submitted simply by creating a pull request.
- 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).
- Please write [tests](#testing) for the changes you make (if applicable).
If you have any questions about contributing to the project, please contact the project owner.
As 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.
The 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.
If `pytest` is installed, the test set can be executed using the `pytest test` command from within the project directory.
If `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.
## License - MIT
The library is open-sourced under the conditions of the MIT [license](https://choosealicense.com/licenses/mit/).