https://github.com/kr4chinin/markdown-renaissance

Minimalistic and stylish high-perfomance markdown editor. Text-highlighting, debounced parsing, presets and much more.
https://github.com/kr4chinin/markdown-renaissance

dark-theme debouncing lazy markdown markdown-editor markdown-parser suspense vite

Last synced: 3 months ago
JSON representation

Minimalistic and stylish high-perfomance markdown editor. Text-highlighting, debounced parsing, presets and much more.

• Host: GitHub
• URL: https://github.com/kr4chinin/markdown-renaissance
• Owner: kr4chinin
• Created: 2022-09-19T18:05:10.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-06-22T21:01:38.000Z (5 months ago)
• Last Synced: 2024-06-23T03:13:54.423Z (5 months ago)
• Topics: dark-theme, debouncing, lazy, markdown, markdown-editor, markdown-parser, suspense, vite
• Language: TypeScript
• Homepage: https://markdown-renaissance.vercel.app
• Size: 1.6 MB
• Stars: 7
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-starred - kr4chinin/markdown-renaissance - Minimalistic and stylish high-perfomance markdown redactor. Text-highlighting, debounced parsing, presets and much more. (markdown)

README

        
# Markdown Renaissance 🏛

I am constantly writing small markdown notes and I've decided to make **minimlistic**, stylish and high-perfomance redactor to sue my needs. This app has

all basic functionality to comfortably write markdown text on **laptops** and **mobile** devices. [Check it live here](http://app.markdown-renaissance.surge.sh/).

## Introduction





### Functionality

- **Text highlighting** while writing markdown, ability to **preview** your markdown notes

- **Debounced** text parsing for higher perfomance, preview **lazy-loading**

- Ability to press button and insert most common markdown **presets** (bold, italic text, header or link) or to clear screen

- You can **store** your session in your browser's local storage and **restore** it later on to continue work

- **Characters** and **words** calculation, ability to hide it

- You can either show or hide markdown preview (it is hidden on the first render to increase TTI)

- Amazing dark theme

App is also optimized for mobile devices:



### Tech stack

- React + TypeScript

- [Vite](https://vitejs.dev)

- SASS

- [highlight.js](https://highlightjs.org) for text highlighting

- [remarkable](https://www.npmjs.com/package/remarkable) for markdown parsing

- Iconify and [react-useanimations](https://react.useanimations.com) for svg icons

- Reach Tooltip for tooltips

- Surge for static page deployment

![App usage](https://user-images.githubusercontent.com/103210607/192013405-e4e7f067-5718-4d37-99be-da64c4cf49bd.gif)

### Further plans

- Add ability to **download** markdown files

- Optimize adaptive layout, work on cross-browser solutions