Skip to main content

How can I get help articles in Markdown format?

Last updated 2 min read

Every Coolhand help article, category page, and product update is available in a Markdown format suitable for programmatic use. You can get the Markdown version of any page by appending `.md` to its URL, or by sending an `Accept: text/markdown` header with your request.

Fetching Markdown content

Every help article, category listing, and product update page has a corresponding Markdown version. This is useful for developers who want to use the documentation in their own tools or with LLM agents. There are two ways to retrieve it.

Append .md to the URL

The most direct way to get the Markdown version of a page is to add .md to the end of its URL path.

For example, to get the Markdown for the article at /help/what-is-feedback-match-rate, you would request:

https://coolhand.com/help/what-is-feedback-match-rate.md

Similarly, for a category page:

https://coolhand.com/help/category/feedback-and-prompts.md

Use the Accept header

You can also request the Markdown format by sending an Accept header with the value text/markdown when requesting the standard HTML URL. The server will respond with a 303 See Other redirect to the corresponding .md URL.

For example, a request to https://coolhand.com/help/what-is-feedback-match-rate with the Accept: text/markdown header will be redirected to https://coolhand.com/help/what-is-feedback-match-rate.md.

curl -H "Accept: text/markdown" https://coolhand.com/help/what-is-feedback-match-rate

Content and links

The Markdown content is sourced directly from the same content as the HTML page, so it is always up-to-date.

Internal links within the Markdown content, such as another-article-slug, are automatically converted into full, absolute URLs. This ensures that the Markdown files are self-contained and that links will resolve correctly when used outside of the Coolhand help center.

Related articles