以编程方式访问 Markdown 文档。
Markdown 指南 API 提供了 JSON 格式的《Markdown 指南》文档子集。我们希望软件开发人员和组织使用此 API 以编程方式使用我们的文档,并在应用程序和网站上显示这些文档。
为什么要为 Markdown 文档创建一个 API?因为网络上有很多重复的 Markdown 文档!似乎每个人都有自己应用程序或网站的 Markdown 文档版本。这很可惜,因为其中大部分内容完全相同。
然后顿悟来了。💡我们意识到我们可以使用《Markdown 指南》中的文档创建一个 JSON API。这样,软件开发人员就可以开始使用 API 将我们的文档包含在他们的应用程序中,而大学和图书馆等组织可以使用 API 将我们的文档包含在其网站上。
我们很高兴看到《Markdown 指南》成为互联网上成千上万条 Markdown 指令的中心文档存储库。它会奏效吗?谁知道呢!但有一件事是肯定的:我们迫不及待地想看看你会用它做什么。🤘
Markdown 指南 API 旨在仅提供必要的 Markdown 文档。因此,API 并未包含《Markdown 指南》网站上提供的所有文档。例如,在列表中添加元素 部分不可通过基本语法端点获得。
基本语法端点包含 John Gruber 设计文档中概述并在基本语法页面中描述的 Markdown 元素的文档。
curl https://markdownguide.cn/api/v1/basic-syntax.json
备忘单端点概述了最流行的基本和扩展 Markdown 语法元素,如备忘单页面中所述。
curl https://markdownguide.cn/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
在 60 页内学习 Markdown。Markdown 指南一书专为新手和专家设计,是一本全面参考书,包含了入门和掌握 Markdown 语法所需的一切内容。
获取本书不要现在就停止!🚀 为 GitHub 存储库 加星,然后在下面输入你的电子邮件地址,通过电子邮件接收新的 Markdown 教程。无垃圾邮件!