旧バージョンのドキュメントを参照しています。最新のドキュメントはこちらをご参照ください。

Markdown レンダリングモジュール

Kong Dev Portalは、テンプレートの代わりに使用できるGithubフレーバーのマークダウン（GFM）をサポートしています。テンプレートのHTMLレイアウトとパーシャルを作成する代わりに、改善されたマークダウンレンダリングモジュールでカスタムCSSを使用できます。マークダウンのサポートが拡張されたため、特にテーブルのレンダリングが大幅に向上します。

前提条件

Kong Managerへのアクセス
Dev Portalが有効かつ実行中

ドキュメント内のマークダウンレンダリングモジュールの指定

Dev Portalドキュメント用のマークダウンファイルを作成します。
layoutパラメータを使用してマークダウンモジュールを呼び出します。
使用する.cssファイルを指定します。表示されているとおり、デフォルトの Githubである.cssを使用することも、独自のカスタム.cssを指定することもできます。
- すべてのマークダウンCSSクラスの前には.markdown-bodyを追加する必要があります。これは、マークダウンスタイルがポータルの他の領域に及ばないようにするためです。
- .cssファイルは現在のテーマの/assetsディレクトリに配置する必要があります。
- レンダラーは、 .cssパスが/assetsディレクトリから開始すると想定します。以下の例を参照してください。
- markdown.css の外部にある他の Dev Portal CSS で定義されている他のクラスは、レンダリングされたマークダウンを汚染する可能性があります。特定のスタイルの設定を解除するには、/assets/style/markdown-fixes.css ファイルを使用します。

例

/content/markdown-example.md

---
layout: system/markdown.html
css: assets/style/markdown.css
---