riccardo/markdown2png
Archived
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
PNG converter for Markdown files
This repository has been archived on 2026-03-21. You can view files and clone it, but you cannot make any changes to its state, such as pushing and creating new issues, pull requests or comments.
36 commits 2 branches 0 tags 181 KiB
  • TypeScript 75.4%
  • JavaScript 12.1%
  • CSS 8.4%
  • Dockerfile 4.1%
Find a file
Exact
Riccardo Senica f5cb3e20d1 fix: correct imports order
2026-01-22 18:58:38 +01:00
.gitea/workflows fix: correct infrastructure path 2026-01-22 17:39:14 +00:00
app fix: correct imports order 2026-01-22 18:58:38 +01:00
utils feat: online converter 2025-02-15 15:19:03 +01:00
.editorconfig First version done 2024-11-16 14:35:32 +01:00
.eslintrc.js feat: online converter 2025-02-15 15:19:03 +01:00
.gitignore Initial commit 2024-11-16 14:17:38 +01:00
.prettierrc feat: online converter 2025-02-15 15:19:03 +01:00
.yarnrc.yml First version done 2024-11-16 14:35:32 +01:00
Dockerfile fix: use standard Next.js build 2026-01-18 16:56:11 +00:00
LICENSE Initial commit 2024-11-16 14:17:38 +01:00
next-env.d.ts feat: online converter 2025-02-15 15:19:03 +01:00
next.config.js feat: online converter 2025-02-15 15:19:03 +01:00
package.json feat: replace analytics 2026-01-22 18:34:12 +01:00
postcss.config.js feat: online converter 2025-02-15 15:19:03 +01:00
README.md docs: update readme 2025-02-15 15:30:55 +01:00
tailwind.config.js feat: online converter 2025-02-15 15:19:03 +01:00
tsconfig.json feat: online converter 2025-02-15 15:19:03 +01:00
yarn.lock build(deps): bump next in the npm_and_yarn group across 1 directory 2025-12-12 21:48:28 +00:00

README.md

markdown2png

A web-based tool built with Next.js that converts Markdown files to PNG images with GitHub-style formatting.

Features

  • Browser-based Markdown to PNG conversion
  • GitHub-style syntax highlighting
  • Live preview
  • High-quality PNG output

Tech Stack

  • Next.js 13.5
  • React 18
  • TypeScript
  • TailwindCSS
  • marked (for Markdown parsing)
  • highlight.js (for syntax highlighting)
  • html-to-image (for PNG conversion)

Requirements

  • Node.js
  • yarn

Installation

  1. Clone the repository:
git clone https://github.com/riccardosenica/markdown2png.git
cd markdown2png
  1. Install dependencies:
yarn

Development

To run the development server:

yarn dev

Open http://localhost:3000 with your browser to see the result.

Available Scripts

  • yarn dev - Runs the development server
  • yarn build - Creates a production build
  • yarn start - Runs the production server
  • yarn lint - Runs ESLint
  • yarn format - Formats code with Prettier
  • yarn typecheck - Runs TypeScript type checking

Usage

  1. Upload your Markdown (.md) file using the file input
  2. Preview your formatted Markdown with syntax highlighting
  3. Click "Convert to PNG" to download your image