Developer-focused Markdown editor for real-time preview using the GitHub Markdown API. It delivers authentic GitHub Flavored Markdown rendering with a side-by-side editor and responsive layout for seamless writing.
https://github-markdown.vercel.app
-
Official GitHub Rendering: Uses the GitHub API (
/markdown) for authentic GitHub Flavored Markdown (GFM) rendering. -
Side-by-Side Editor: Real-time preview with a 700ms debounce to save on API requests.
-
GitHub Dark Mode Styling: Implements
github-markdown-cssto match the exact look and feel of GitHub's documentation. -
Rate Limit Bypass: Custom field to add your GitHub Personal Access Token (PAT), bumping your limit from 60 to 5,000 requests per hour.
-
Fully Responsive: Mobile-friendly layout that stacks correctly on small screens.
Follow these steps to run the project locally on your machine.
-
Node.js: version
>20+ -
Package Manager:
pnpm(recommended)
Bash
git clone https://github.com/aungchanpyae33/github-markdown.git
cd github-markdown
pnpm install
pnpm run dev
Open http://localhost:5173 in your browser.
If you find this project useful, please give it a ⭐!
Contributions are welcome!
Please read the contribution guide before submitting a pull request.
This project is licensed under the MIT License. See the LICENSE file for details.