API

はじめに

Markdown ガイド API は、Markdown ガイドの文書を JSON 形式で提供します。ソフトウェア開発者や組織が API を使用し、ドキュメントをプログラムで利用して、アプリケーションや Web サイトに表示することを願っています。

なぜですか？

Markdown ドキュメント用の API を作ったのは、Web 上に重複した Markdown ドキュメントが数多くあるからです。すべての人が、アプリケーションや Web サイト用の独自の Markdown ドキュメントを持っているようです。それは残念です。ほとんどが同じだからです。

その後、ひらめきました。💡Markdown ガイドのドキュメントを使用して JSON API を作成できることに気付きました。これにより、ソフトウェア開発者は API を使用してアプリケーションにドキュメントを含めることができ、大学や図書館などの組織は API を使用して Web サイトにドキュメントを含めることができます。

Markdown ガイドが、インターネット上に散らばる何千もの Markdown 指示の中心的なドキュメントリポジトリになることが望まれます。うまくいくでしょうか？分かりません！ただ一つ確かことは、皆様がこの API をどのように活用されるか楽しみにしているということです。🤘

制限事項

Markdown ガイド API は、必須の Markdown ドキュメントのみを提供するように設計されています。その結果、API には Markdown ガイド Web サイトで利用可能なドキュメントの一部は含まれません。たとえば、「リストに要素を追加する」セクションは、基本構文エンドポイントでは利用できません。

基本構文のエンドポイント

基本構文のエンドポイントには、John Gruber の設計文書に記載され、基本構文ページで説明されている Markdown 要素に関するドキュメントが含まれています。

リクエスト

curl https://markdownguide.dokyumento.jp/api/v1/basic-syntax.json

レスポンス

チートシート エンドポイント

チートシート エンドポイントは、チートシート ページで説明されている、最も一般的な基本 Markdown 構文と拡張 Markdown 構文の概要を提供します。

リクエスト

curl https://markdownguide.dokyumento.jp/api/v1/cheat-sheet.json

レスポンス

変更履歴

Markdown ガイド API に加えたすべての変更を以下に示します。

2018-10-18
- Updated cheat sheet endpoint to include information about definition lists

2018-07-12
- Updated links description to include information about adding titles

2017-11-10
- Added cheat sheet endpoint

2017-11-04
- Added section about escaping backticks in code

2017-10-24
- Released API v1
- Published docs

Markdown のスキルを次のレベルに引き上げましょう。

60 ページで Markdown を学びましょう。初心者とエキスパートの両方に向けて設計された Markdown ガイドの書籍は、Markdown 構文を始め、マスターするために必要なすべてを含む包括的なリファレンスです。

書籍を入手する