toc | Riebeckite

記事の見出しから目次を生成・表示する Plugin です。

導入

npm install @riebeckite/plugin-toc

Plugin の export 名や設定項目は、実装と package README を一次情報として確認してください。Riebeckite の Plugin は riebeckite.config.ts の plugins に登録して利用します。

使用例

長い記事に複数の見出しを置くと、読者が現在位置を確認しながら各セクションへ移動できる目次を提供できます。

# Plugin Guide
## Installation
## Configuration
## Usage
## Troubleshooting

このページのサイドバーにある「CONTENTS」に目次が並び、スクロールに合わせて現在の節が強調されます。節が2件未満のページでは表示されません。

使いどころ

この Plugin が必要な場合だけ追加してください。Preset に含まれている場合は、同じ Plugin を重複して登録する必要はありません。

実際の表示例が用意されている場合は、Plugin Showcase でも確認できます。

詳細仕様

設定項目、公開 API、制約、追加の使用例は package README を参照してください。Plugin 全体の仕組みは Plugin System、Plugin を作る場合は Writing a Plugin を参照してください。

History

1 changesCollapseExpand

From To

	1	`+ # Table of Contents`
	2	`+`
	3	`+ 記事の見出しから目次を生成・表示する Plugin です。`
	4	`+`
	5	`+ ## 導入`
	6	`+`
	7	+ ```bash
	8	`+ npm install @riebeckite/plugin-toc`
	9	+ ```
	10	`+`
	11	+ Plugin の export 名や設定項目は、実装と package README を一次情報として確認してください。Riebeckite の Plugin は `riebeckite.config.ts` の `plugins` に登録して利用します。
	12	`+`
	13	`+ ## 使用例`
	14	`+`
	15	`+ 長い記事に複数の見出しを置くと、読者が現在位置を確認しながら各セクションへ移動できる目次を提供できます。`
	16	`+`
	17	+ ```markdown
	18	`+ # Plugin Guide`
	19	`+ ## Installation`
	20	`+ ## Configuration`
	21	`+ ## Usage`
	22	`+ ## Troubleshooting`
	23	+ ```
	24	`+`
	25	`+ このページのサイドバーにある「CONTENTS」に目次が並び、スクロールに合わせて現在の節が強調されます。節が2件未満のページでは表示されません。`
	26	`+`
	27	`+ ## 使いどころ`
	28	`+`
	29	`+ この Plugin が必要な場合だけ追加してください。Preset に含まれている場合は、同じ Plugin を重複して登録する必要はありません。`
	30	`+`
	31	`+ 実際の表示例が用意されている場合は、[Plugin Showcase](./showcase.ja.md) でも確認できます。`
	32	`+`
	33	`+ ## 詳細仕様`
	34	`+`
	35	`+ 設定項目、公開 API、制約、追加の使用例は package README を参照してください。Plugin 全体の仕組みは [Plugin System](../framework/plugin-system.ja.md)、Plugin を作る場合は [Writing a Plugin](./writing-a-plugin.ja.md) を参照してください。`
	36	`+`
	37	`+`