ソフトウェア
Slate API Docs Generator の代わりとなる 27 個の無料および有料のリストをまとめました。 主な競合相手はDoxygen、 Docsieです。 これらに加えて、ユーザーは Slate API Docs Generator と swagger.io、 Wikitten、 DocsApp の間の比較も行います。 また、他の同様のオプションもここで確認できます: 開発ツール。
61
42
36
34
33
27
23
19
15
14
23
美しく、インテリジェントで、レスポンシブなAPIドキュメントを作成します。
美しく、インテリジェントで、レスポンシブなAPIドキュメントを作成します。
Linux
Mac
スレート-APIの美しい静的ドキュメント。
特徴
すっきりした直感的なデザイン— Slateでは、APIの説明がドキュメントの左側にあり、すべてのコード例が右側にあります。 StripeおよびPaypalのAPIドキュメントに触発されました。 スレートは応答性が高いため、タブレット、携帯電話、さらには印刷物でも見栄えがします。
単一ページ上のすべて—ユーザーが必要なものを見つけるために100万ページを検索しなければならなかった時代は終わりました。 Slateはドキュメント全体を1ページに配置します。 ただし、リンク可能性を犠牲にしていません。 スクロールすると、ブラウザのハッシュが最も近いヘッダーに更新されるため、ドキュメント内の特定のポイントへのリンクは自然で簡単です。
Slateは単なるMarkdown — Slateでドキュメントを書くときは、Markdownを書くだけで、編集と理解が簡単になります。 すべてがMarkdownで記述されています。コードサンプルも単なるMarkdownコードブロックです。
複数の言語でコードサンプルを書く— APIに複数のプログラミング言語のバインディングがある場合、タブを簡単に入れてそれらを切り替えることができます。 ドキュメントでは、Github Flavored Markdownの場合と同様に、各コードブロックの上部に言語名を指定することで、異なる言語を区別します。
ほぼ60の言語に対応した、すぐに使用可能な構文強調表示。構成は不要です。
ページの左端の目次が自動的にスムーズにスクロールします。 スクロールすると、ドキュメント内の現在の位置が表示されます。 それも速いです。 TripItでSlateを使用して、目次が180を超える新しいAPIのドキュメントを作成しています。 大規模なドキュメントであっても、パフォーマンスが優れたままであることを確認しました。
ソフトウェアについての意見を共有し、レビューを残してさらに向上させるのに役立てましょう！
変更の提案
あなたのフィードバック
Your vote has been counted.
Do you have experience using this software?
