|
1 | | -This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app). |
| 1 | +# MarkBloom |
2 | 2 |
|
3 | | -## Getting Started |
| 3 | +Free, open-source Markdown to PDF converter that runs entirely in your browser. Write Markdown, see a live preview, and export beautifully formatted PDFs — no sign-up, no server uploads. Your content never leaves your device. |
| 4 | + |
| 5 | +[Live Demo](https://mertguvencli.github.io/markbloom) |
| 6 | + |
| 7 | + |
| 8 | + |
| 9 | + |
| 10 | + |
4 | 11 |
|
5 | | -First, run the development server: |
| 12 | +## Features |
| 13 | + |
| 14 | +- **Live Editor** — CodeMirror 6 powered Markdown editor with syntax highlighting |
| 15 | +- **Real-Time Preview** — Instant side-by-side preview as you type |
| 16 | +- **PDF Export** — One-click export with smart pagination and page break detection |
| 17 | +- **Multiple Page Sizes** — A4, US Letter, and Legal support |
| 18 | +- **GitHub Flavored Markdown** — Tables, task lists, strikethrough, and more |
| 19 | +- **Syntax Highlighting** — 100+ languages with Shiki (GitHub Dark theme) |
| 20 | +- **100% Client-Side** — Zero backend, zero data collection, complete privacy |
| 21 | + |
| 22 | +## Getting Started |
6 | 23 |
|
7 | 24 | ```bash |
8 | | -npm run dev |
9 | | -# or |
10 | | -yarn dev |
11 | | -# or |
| 25 | +# Clone the repository |
| 26 | +git clone https://github.com/mertguvencli/markbloom.git |
| 27 | +cd markbloom |
| 28 | + |
| 29 | +# Install dependencies |
| 30 | +pnpm install |
| 31 | + |
| 32 | +# Start development server |
12 | 33 | pnpm dev |
13 | | -# or |
14 | | -bun dev |
15 | 34 | ``` |
16 | 35 |
|
17 | | -Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. |
| 36 | +Open [http://localhost:3000](http://localhost:3000) in your browser. |
18 | 37 |
|
19 | | -You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file. |
| 38 | +## Tech Stack |
20 | 39 |
|
21 | | -This project uses [`next/font`](https://nextjs.org/docs/app/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel. |
| 40 | +| Category | Technology | |
| 41 | +|---|---| |
| 42 | +| Framework | Next.js 16, React 19, TypeScript | |
| 43 | +| Editor | CodeMirror 6 | |
| 44 | +| Markdown | React Markdown, Remark GFM, Rehype Raw | |
| 45 | +| Code Highlighting | Shiki | |
| 46 | +| Styling | Tailwind CSS 4, shadcn/ui, Radix UI | |
| 47 | +| PDF Generation | html2canvas-pro, jsPDF | |
22 | 48 |
|
23 | | -## Learn More |
| 49 | +## Build & Deploy |
24 | 50 |
|
25 | | -To learn more about Next.js, take a look at the following resources: |
| 51 | +```bash |
| 52 | +# Production build |
| 53 | +pnpm build |
| 54 | + |
| 55 | +# Start production server |
| 56 | +pnpm start |
| 57 | +``` |
26 | 58 |
|
27 | | -- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API. |
28 | | -- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial. |
| 59 | +The project is configured for static export and can be deployed to GitHub Pages or any static hosting provider. |
29 | 60 |
|
30 | | -You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome! |
| 61 | +## Contributing |
31 | 62 |
|
32 | | -## Deploy on Vercel |
| 63 | +Contributions are welcome! Feel free to open issues and pull requests. |
33 | 64 |
|
34 | | -The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js. |
| 65 | +## License |
35 | 66 |
|
36 | | -Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details. |
| 67 | +[MIT](LICENSE) |
0 commit comments