API

Programmatically access Markdown documentation.

The Markdown Guide API provides Markdown documentation in JSON format, allowing you to programmatically access and use our documentation in your applications and websites for free.

Note: Hey there! :wave: We just launched this, so if you see anything wonky, please let us know by filing an issue on GitHub.

Introduction

The Markdown Guide API provides a subset of documentation from the Markdown Guide in JSON format. We hope that software developers and organizations use this API to programmatically consume our documentation and display it in applications and on websites.

Why?

Why create an API for Markdown documentation? Because there’s so much duplicated Markdown documentation on the web! It seems like everybody has their own version of Markdown documentation for their application or website. That’s a shame since most of it is exactly the same.

Then came the epiphany. :bulb: We realized we could create a JSON API using documentation from the Markdown Guide. That way, software developers could start using the API to include our documentation in their applications, and organizations like universities and libraries could use the API to include our documentation on their websites.

We’d love to see the Markdown Guide become the central documentation repository for the thousands of Markdown instructions sprinkled around the internet. Will it work? Who knows! One thing’s for sure though: We can’t wait to see what you do with it. :metal:

Limitations

The Markdown Guide API is designed to provide only essential Markdown documentation. As a result, the API doesn’t include all of the documentation available on the Markdown Guide website. For example, the Adding Elements in Lists section is not available through the basic syntax endpoint.

Basic Syntax Endpoint

The basic syntax endpoint contains documentation about the Markdown elements outlined in John Gruber’s design document and described on the Basic Syntax page.

Request

curl https://www.markdownguide.org/api/v1/basic-syntax.json

Response

Cheat Sheet Endpoint

The cheat sheet endpoint provides an overview of the most popular basic and extended Markdown syntax elements, as described on the Cheat Sheet page.

Request

curl https://www.markdownguide.org/api/v1/cheat-sheet.json

Response

Changelog

Here’s a list of all the changes we’ve made to the Markdown Guide API.

2017-11-10
- Added cheat sheet endpoint

2017-11-04
- Added section about escaping tick marks in code

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