Naked Doc はヘッダー、サイドバー、コンテンツの 3 つの要素で構成されています。 config.ts を編集することであなた好みのドキュメントにカスタマイズ可能です。

以下に主に設定する必要性の高い項目について紹介します。

1. ヘッダー

簡単にソーシャルリンクを設定することができます。 (ex: Github, Twitter...)

ロゴ

config.header.logoにロゴの画像リンクをしてください

ロゴをクリックして、リンクへアクセスできるようにしたい場合は、config.header.logoLinkを編集してください。

検索エンジン

使用するドキュメントの検索エンジンを選択できます。

Lunr

チーム内部のみで公開する秘匿性の高いドキュメントの場合はこちらを推奨します。

config.header.searchをlunrにするだけです。

Algolia

検索エンジンのパフォーマンスを求めるのであればこちらを推奨します。ただし、事前に Algolia へユーザー登録しておく必要があります。

config.header.searchにalgoliaを設定して、.envファイルに Algolia API Keys を設定してください。ダッシュボードから取得できます。

その後、npm run buildでドキュメントのデータを Algolia へプッシュするようにしてください。

2. サイドバー

ドキュメントのセクションの順序を制御する場合は、config.sidebar.forcedNavOrderを編集します。

セクションを折りたたむかどうかを制御する場合は、config.sidebar.collapsedNavを編集します。

3. マークダウンコンテント

ドキュメントを記述するマークダウンファイルをcontentフォルダに配置してください。

セクションを作成する場合は、contentフォルダーにフォルダーを作成します。

Edit this page ボタン

Naked Doc はドキュメントからソースリポジトリリンクにアクセスできる仕組みがあります。

config.siteMetadata.docsLocationにリポジトリの URL を設定してください。