Skip to main content

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


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)

Uploaded Source

Built Distribution

sphinx_shikijs-0.1.0a0-py3-none-any.whl (4.1 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page