Skip to content

README.md

Latest commit

 

History

History
executable file
·
44 lines (34 loc) · 1.26 KB

README.md

File metadata and controls

executable file
·
44 lines (34 loc) · 1.26 KB

Markdown Editor

GitHub license PRs Welcome Build & deploy

A modern, fast, and minimalist Markdown editor built with React 19 and Vite.

Features

  • Real-time Preview: Side-by-side editing and rendering.
  • Math & Formulas: Integrated KaTeX support for mathematical expressions.
  • Syntax Highlighting: Beautiful code blocks powered by prism/hlj.
  • Functional Minimalism: design—focusing on clarity

Getting Started

Installation

npm install

Development

Run the app in development mode:

npm run dev
# or
npm start

Build

Build the app for production (output to dist/):

npm run build

Testing

Run the test suite using Vitest:

npm run test

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

License

MIT licensed.