No project description provided
Project description
sphinx-shikijs
Use Shiki to highlight code.
Installation
pip install sphinx-shikijs
Then, add sphinx_shikijs to your extensions in conf.py:
extensions = [
# ...
"sphinx_shikijs",
]
Configuration
| Setting | Default | Description |
|---|---|---|
| shikijs_mode | "cli" |
Either "cli" or "browser". In browser mode, this will load Shiki from unpkg. |
| shikijs_path | "shiki-cli" |
Path to a Shiki CLI executable. |
| shikijs_highlight_theme | "dark-plus" |
A Shiki theme. For possible themes, see here |
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file sphinx_shikijs-0.1.0a0.tar.gz.
File metadata
- Download URL: sphinx_shikijs-0.1.0a0.tar.gz
- Upload date:
- Size: 3.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.3.2 CPython/3.11.1 Darwin/22.4.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 2b81452f30936549825b6e8f33e395ac14c8fc7305c302c5ca9faaa55966381a |
|
| MD5 | 49860f281dd3bbacc4615b71a43d7243 |
|
| BLAKE2b-256 | 81f2e227e90679ee08bf5f1a9fa792fb04093539a2b9c80bb58dbc36bf711672 |
File details
Details for the file sphinx_shikijs-0.1.0a0-py3-none-any.whl.
File metadata
- Download URL: sphinx_shikijs-0.1.0a0-py3-none-any.whl
- Upload date:
- Size: 4.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.3.2 CPython/3.11.1 Darwin/22.4.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 8176578e86d8f85fa4e9c6557102114bf7b98292fa5f5ba018ed210d58b71516 |
|
| MD5 | 240a6fd6bdf2dce24724200fb43a1e38 |
|
| BLAKE2b-256 | 54ec391ebf21b8694eaa55e46624a826ea1115ad82abcaa4ce62847e19415467 |
