16
スレート-APIの美しい静的ドキュメント。機能クリーンで直感的なデザイン— Slateでは、APIの説明はドキュメントの左側にあり、すべてのコード例は右側にあります。StripeおよびPaypalのAPIドキュメントに触発されました。スレートは応答性が高いため、タブレット、携帯電話、さらには印刷物でも見栄えがします。単一のページ上のすべて—ユーザーが欲しいものを見つけるために100万ページを検索する必要があった時代は終わりました。Slateは、ドキュメント全体を1ページに配置します。ただし、リンク可能性を犠牲にすることはありません。スクロールすると、ブラウザのハッシュが最も近いヘッダーに更新されるため、ドキュメント内の特定のポイントへのリンクは自然で簡単です。Slateは単なるMarkdown — Slateでドキュメントを書くときは、Markdownを書くだけなので、編集と理解が簡単になります。すべてがMarkdownで記述されています。コードサンプルも単なるMarkdownコードブロックです。複数の言語でコードサンプルを記述する— APIに複数のプログラミング言語のバインディングがある場合、タブを簡単に入れてそれらを切り替えることができます。ドキュメントでは、Github Flavored Markdownの場合と同様に、各コードブロックの上部に言語名を指定することにより、異なる言語を区別します。ほぼ60の言語に対応した、すぐに使用可能な構文強調表示、構成は不要です。ページの左端にある目次の自動スクロール。スクロールすると、ドキュメント内の現在の位置が表示されます。それも速いです。TripItのSlateを使用して、目次が180を超える新しいAPIのドキュメントを作成しています。大規模なドキュメントでも、パフォーマンスが優れたままであることを確認しています。
slate-api-docs-generator
ウェブサイト:
https://github.com/tripit/slateカテゴリー
