Markdown Editor - A fast, modern Next.js-based editor for working with Markdown (.md) files with a live preview, Git hosting integrations, and export options.
This project provides a lightweight, accessible Markdown editor focused on writing and previewing Markdown files with first-class support for:
- Live preview (synchronized editing)
- Platform specific formatting (GitHub, GitLab, Bitbucket & More)
- Export to HTML, PDF, and plain text
- Tailwind-based UI and shadcn-friendly components
This repository is a Next.js + TypeScript application with Prettier, ESLint, and Husky hooks configured.
- Live preview pane with Markdown rendering
- Support for platform specific formatting (GitHub, GitLab, Bitbucket & More)
- Export to HTML / PDF / Text
- Keyboard shortcuts and undo/redo history
- Dark & light themes
- Small, modular UI components compatible with
shadcn/ui
Light Mode Preview:
Dark Mode Preview:
- Local docs:
LINTING.md,CI.md - CI: See
.github/workflows/ci.yml
- Clone the repository
git clone https://github.com/tristanbudd/markdown-editor.git
cd markdown-editor- Install dependencies (uses pnpm)
pnpm install- Run development server
pnpm devOpen http://localhost:3000 in your browser.
Common scripts included in package.json:
pnpm dev # Start Next.js in development mode
pnpm build # Build for production
pnpm start # Start the production server
pnpm lint # Run ESLint
pnpm lint:fix # Fix lint issues
pnpm format # Run Prettier to format files
pnpm format:check # Check formatting
pnpm typecheck # Run TypeScript type checking- This project uses Next.js 16, React 19, TypeScript 5 and Tailwind CSS.
- Prettier is configured with Tailwind and import sorting plugins.
- Husky + lint-staged runs ESLint and Prettier on staged files.
If you'd like to contribute, please read CONTRIBUTING.md and follow these general guidelines:
- Fork the repository and create a branch for your feature/fix.
- Run
pnpm installand make changes. - Keep commits small and focused; add tests where appropriate.
- Ensure formatting/linting passes locally:
pnpm lint && pnpm format:check && pnpm typecheck. - Open a pull request describing the change and linking related issues.
This repo contains templates under .github/ISSUE_TEMPLATE and .github/PULL_REQUEST_TEMPLATE.md to help standardize contributions.
If you discover a security vulnerability, please open a private issue and mark it sensitive, or follow SECURITY.md.
This project is licensed under the MIT License, see the LICENSE file for details.