Skip to content

jacob-ebey/github-md

Repository files navigation

github-md

A markdown parser API for GitHub. SWR for 2 days with revalidation every 5 minutes.

Source: https://github.com/jacob-ebey/github-md

You can change the URL when browsing github to to include -md for a preview of the rendered markdown

Endpoints

Parse Markdown

/[username]/[repository]/[branch|tag|sha]/[filepath]

Response

  • attributes: The attributes parsed off the front matter
  • html: The HTML rendered from the markdown

Examples:

List Markdown Files

/[username]/[repository]/[branch|tag|sha]

Response

  • sha: The sha of the commit
  • files: The list of files in the format of { path: string; sha: string }

Examples: