highlight.js - にほんご。

Style guide

基本的な方針

highlight.jsのテーマは言語に依存しません。

豊富なハイライト用のクラスで、一握りの言語の見た目を良くするのではなく、 限られたクラスで全ての言語に対応させます。

したがって、大事な2つの意義があります。

  • hilight.jsのスタイルはミニマルな傾向があります。
  • 他のハイライトエンジンからは、テーマを正しくエミュレートすることはできません。

テーマの定義

テーマは、クラスリファレンスに記載されたスタイルを定義したCSSです。 一般的なガイドラインは、使用可能な全てのクラスをスタイルすることです。 しかし、テーマの作者は、いくつかのスタイルを定義しないかもしれません。 (例えば、通常.attrはスタイルを定義していません。)

クラス名ごとに分けてスタイルを定義する必要はなく、 グループ化して定義することができます。

.hljs-string,
.hljs-section,
.hljs-selector-class,
.hljs-template-variable,
.hljs-deletion {
  color: #800;
}

組み合わせたいスタイルを定義することができます。


タイポグラフィとレイアウトの注意事項

使用禁止

  • .hljsのルートコンテナでの非標準なbordermarginpadding
  • 使用するフォントの指定。
  • font-sizeline-height等、コンテナ内の文字の位置やサイズに影響するスタイル

使用可能

  • color(当然です!)
  • italicboldunderlining等。
  • background-image

初めは任意であるように思うかもしれませんが、 実際に使ってみると意味が分かります。

また、ルートコンテナには、 必ず定義しなければならない共通のスタイルがあります。

.hljs {
  display: block;
  overflow-x: auto;
  padding: 0.5em;
}

.subst

大事な注意事項:.substにスタイルを指定するのを忘れないでください。 これは文字列内の文字解析時に使用され、 ほとんどの場合、デフォルトの色にリセットしなければなりません。

.hljs,
.hljs-subst {
  color: black;
}

コントリビュート

CSSファイルの最上部には、 帰属や、その他必要な情報をコメントととして挿入する必要があります。 フォーマットは自由です。

/*
 
Fancy style (c) John Smith 
 
*/

もしあたなが新規のコントリビューターであれば、 "AUTHORS.*.txt"に名前を追加してください。 (英語版または、ロシア語版、もしくは両方をを使って下さい。) そして、CHANGES.mdも更新してください。

コントリビュートをGitHubでプルリクエストしてください。


© 2006 Highlight.js is released under the BSD License. See LICENSE file for details.

このコンテンツはhighlightjsドキュメントを翻訳/改変したものです。