By Ryota Saito in Remark — Jul 18, 2022

Remarkの設定項目について

Remarkのオプションについてまとめてみました。

はじめに

前回の記事でRemarkの設定方法を記事にしましたが、様々な設定項目が存在したので、整理しておきたいと思います。

設定一覧

設定項目	説明	設定候補	デフォルト設定
gfm	GFM互換のMarkdownに必要なエスケープでシリアル化する	`true` or `false`	`false`
commonmark	CommonMark互換のMarkdownのシリアル化する	`true` or `false`	`false`
entities	エンティティをシリアル化する方法を指定する	`numbers` or `escape` or `true` or `false`	`false`
setext	可能であれば、Setext-styleの見出しをシリアル化する	`true` or `false`	`false`
closeAtx	開始ハッシュと同じ量の終了ハッシュでATX見出しをシリアル化する	`true` or `false`	`false`
tableCellPadding	テーブル作成時にセル区切り文字（\|）とコンテンツの間にスペースを追加する	`true` or `false`	`true`
tablePipeAlign	テーブルセルの間に区切り文字（\|）を配置して、グリッドが形成されるようにする	`true` or `false`	`true`
stringLength	テーブルセルの長さを検出するためにマークダウンテーブルに渡される関数	関数を設定	`s=>s.length`
fence	フェンスされたコードブロックに使用するマーカー	` or `'~'`	'`'
bullet	順序付けられていないリストアイテムの箇条書きに使用するマーカー	`'-'` or `'*'` or `'+'`	`'-'`
listItemIndent	リストアイテムのインデントのスタイル	`'tab'` or `'mixed'` or `'1'`	`'tab'`
incrementListMarker	順序付きリストアイテム番号をインクリメント	`true` or `false`	`true`
rule	テーマ別の区切り/水平線に使用するマーカー	`'-'` or `'*'` or `'_'`	`*`
ruleRepetition	テーマ別の区切り/水平線に使用するマーカーの数	数字	3
ruleSpaces	主題の区切り（水平線）マーカーの間にスペースを置きます	`true` or `false`	`true`
strong	太字にする際のマーカー	`'_'` or `'*'`	`'*'`
emphasis	強調に使用するマーカー	`'_'` or `'*'`	`'_'`

※ pedantic は今後削除される予定なので、紹介していません

さいごに

今回の設定一覧を作成した事で、自分の設定を見直す事ができました。プログラミングを行う上で一番重要なのは環境構築と言っても過言ではないくらい重要なので、環境の設定はこだわっていきたいと思います。