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 |
Project details
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
sphinx_shikijs-0.1.0a0.tar.gz
(3.6 kB
view hashes)
Built Distribution
Close
Hashes for sphinx_shikijs-0.1.0a0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8176578e86d8f85fa4e9c6557102114bf7b98292fa5f5ba018ed210d58b71516 |
|
MD5 | 240a6fd6bdf2dce24724200fb43a1e38 |
|
BLAKE2b-256 | 54ec391ebf21b8694eaa55e46624a826ea1115ad82abcaa4ce62847e19415467 |