atrnh / sphinx-shikijs

Use Shiki to highlight code.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

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

About

Use Shiki to highlight code.


Languages

Language:Python 71.8%Language:JavaScript 27.0%Language:Just 1.2%