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

A markdown parser API for GitHub
https://github.com/jacob-ebey/github-md

api cloudflare-workers github markdown

Last synced: about 22 hours ago
JSON representation

A markdown parser API for GitHub

• Host: GitHub
• URL: https://github.com/jacob-ebey/github-md
• Owner: jacob-ebey
• Created: 2022-05-11T09:08:33.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-03-29T17:08:24.000Z (8 months ago)
• Last Synced: 2024-08-07T08:14:55.528Z (3 months ago)
• Topics: api, cloudflare-workers, github, markdown
• Language: TypeScript
• Homepage: https://github-md.com
• Size: 153 KB
• Stars: 77
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# 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

```text

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

```

#### Response

- `attributes`: The attributes parsed off the front matter

- `html`: The HTML rendered from the markdown

#### Examples:

- https://github-md.com/remix-run/remix/main/docs/index.md

- https://github-md.com/facebook/react/17.0.2/README.md

### List Markdown Files

```text

/[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:

- https://github-md.com/remix-run/remix/main

- https://github-md.com/facebook/react/17.0.2