Pre-release
This release is a pre-release and may not be stable for production use.
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 |
1 maintainer
Release files for sphinx-shikijs 0.1.0a0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| sphinx_shikijs-0.1.0a0.tar.gz | 3.6 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| sphinx_shikijs-0.1.0a0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 7.7 kB
Release files / sphinx_shikijs-0.1.0a0.tar.gz
| Download URL | sphinx_shikijs-0.1.0a0.tar.gz |
|---|---|
| Size | 3.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
2b81452f30936549825b6e8f33e395ac14c8fc7305c302c5ca9faaa55966381a
|
|
BLAKE2b-256 checksum How to use checksums |
81f2e227e90679ee08bf5f1a9fa792fb04093539a2b9c80bb58dbc36bf711672
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.3.2 CPython/3.11.1 Darwin/22.4.0
|
Release files / sphinx_shikijs-0.1.0a0-py3-none-any.whl
| Download URL | sphinx_shikijs-0.1.0a0-py3-none-any.whl |
|---|---|
| Size | 4.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
8176578e86d8f85fa4e9c6557102114bf7b98292fa5f5ba018ed210d58b71516
|
|
BLAKE2b-256 checksum How to use checksums |
54ec391ebf21b8694eaa55e46624a826ea1115ad82abcaa4ce62847e19415467
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.3.2 CPython/3.11.1 Darwin/22.4.0
|
