shiki README

The project's README from github.com/shikijs/shiki. As one markdown file: README.md.

Shiki Logo

Shiki 式

NPM version NPM downloads Codecov

A beautiful syntax highlighter based on TextMate grammar, accurate and powerful.

📚 Documentation

Branch

The main branch is currently at v4.x.

Branch Description
v3 v3.23 of Shiki
v2 v2.5 of Shiki
v1 v1.29 of Shiki
v0 v0.14 of Shiki, the legacy version

License

MIT

shiki (shikijs/shiki)

Searching Database…

13.9K ·GitHub
Что это такое?Shiki — это подсветка синтаксиса для фрагментов кода, построенная на грамматике TextMate, поэтому разбиение на токены точное, а результат выглядит аккуратно.
Это библиотека, которую я добавляю в свой проект, или отдельное приложение?Это библиотека на JavaScript/TypeScript (опубликована как пакет 'shiki'), которую вы импортируете, чтобы подсвечивать код программно, а не самостоятельное приложение.
Как начать использовать её для подсветки кода?Этот фрагмент README не показывает команды установки, но как npm-пакет 'shiki' его можно добавить через менеджер пакетов и вызывать его API подсветки из JS/TS, чтобы выводить подсвеченный код.
Зачем есть отдельные ветки v0-v4?Shiki хранит старые основные релизы (v0 — устаревшая, v1, v2, v3) в отдельных ветках, а активная разработка идёт в основной ветке v4.x, чтобы пользователи старого API могли найти подходящую документацию и исправления.
Что на самом деле означает «основано на грамматике TextMate»?Shiki разбивает исходный код на токены по тем же грамматикам TextMate, на которых работает подсветка в VS Code, поэтому цвета и границы токенов близко совпадают с тем, что вы видите в этом редакторе, а не с результатом более простого подсветчика на регулярных выражениях.
Можно ли использовать Shiki в коммерческих целях бесплатно?Да, лицензия MIT, поэтому его можно использовать в коммерческих и открытых проектах с минимальными ограничениями.
Creator
shikijs
Size
16.4 MB
Stars
13.9K
Age
7y
Commits · 90 Days