Shiki syntax highlight support

オープン
#2,530 コメント 5 件 リアクション 4 件 担当者 0 名 GitHub で見る

メンテナーはふだん 3 日以内に返信

まだ誰も着手していません。

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
42/100
issue の種類
機能追加
明瞭さ
説明が足りない
活発さ
静か
技術スタック
javascript
領域
documentation

調査の方向性

Shiki CDN usage guideを読み、docsifyに既存するPrismおよびhighlight.jsの統合ポイントを調査してください。設定オプションによってShiki互換のクラスプレフィックスを選択できる方法を決定し、各ハイライターに期待される出力を定義してください。既存の構文ハイライトオプションを壊すことなくShikiを選択できれば完了です。

索引モデルが issue の本文から書いたものです。

説明

enhancement

Feature request

Problem or desire

Prism syntax highlight is quite bad (highlight.js is bad too).

Proposal

Support Shiki.

Shiki has better syntax highlight because it uses TextMate grammar instead of shady regexp. It uses the same engine as in VS Code.

Implementation

I guess the only thing to do on doscify side, is to add a config option that allows to generate a different highlighter class prefix. That way all JS syntax highlighter could nearly be supported.

  • shiki: css class shiki
  • prism: css class language- prefix
  • highlightjs: css class hljs

https://shiki.style/guide/install#cdn-usage

主要言語
JavaScript
スター
31.6k
フォーク
5.8k
平均マージ
6日 14時間
マージ済み PR(30日)
13

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

docsifyjs/docsify のほかの issue

docsifyjs/docsify の issue をすべて見る

似ている issue

JavaScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。