Skip to content

daniilsjb/markutta

Repository files navigation

Markutta

Markutta is a quick, simple, and progressive Markdown editor with automatic conversion to HTML and CSS.

Type your markup in the editor and see it being rendered on the screen! 🔥

Features

  • Edit your Markdown documents and see them visualized in real-time. 📝
  • Import any Markdown or text files from your filesystem directly into the editor. 🚀
  • If you don't like using buttons, simply drag and drop your file onto the webpage. 💧
  • Export your markup either as raw or styled HTML files without external dependencies. 🥳
  • And, of course, there are both light and dark themes to help you feel more comfortable. 😎

Technologies

This software is powered by several amazing libraries and tools:

Tool Description
React Library for building user interface components using JavaScript.
Vite Development environment for managing and building the project.
Mantine Awesome collection of beautiful and easy-to-use React components.
AceEditor High performance embeddable code editor with syntax highlighting.
Marked Markdown parser built for speed; the primary magic behind Markutta.
DOMPurify HTML sanitizer to ensure that the output doesn't contain malicious code.
Node.js JavaScript runtime environment powering the development process.

What's more, Markutta itself is open-source and can be found over on GitHub!

Running Locally

If you would like to run Markutta yourself, simply do the following:

  1. git clone https://github.com/daniilsjb/markutta
  2. cd markutta
  3. npm install
  4. npm dev

You may now open the localhost URL indicated by Vite to see Markutta running in your web browser. Congratulations!


Disclaimer: This application was built as part of a university assignment at TSI and UWE.

About

A simple, quick, and progressive React-based Markdown editor, built for a university assignment.

Topics

Resources

License

Stars

Watchers

Forks

Contributors