Keeper - A minimal and modern markdown editor!!

Keeper.Demo.-.Portfolio.mov

Table of Contents

• Installation
• Why We Built Keeper
• What It Does
• Major Libraries Used
• Contribution
• Code of Conduct

🛠️ Installation

1. Clone the repository by running git clone https://github.com/Sushants-Git/keeper.git
2. Run cd keeper to change the working directory
3. Run npm i or npm install to install all dependencies
4. Run npm run dev to start the application
5. Visit http://localhost:3000 to view the application

Why We Built Keeper?

Keeper is a markdown editor and previewer. Many existing editors were bolted with features, lacking functionalities like text-to-speech and comprehensive code syntax highlighting. This project was inspired by the desire to create a markdown editor that is both minimalist and feature-rich.

What It Does

Keeper is a markdown editor and previewer that brings together the best of both worlds. Here's what it offers:

• Text-to-Speech: Transform your written notes into spoken words with ease.
• Syntax Highlighting: Enjoy syntax highlighting for a wide range of programming languages, making your code snippets more readable.
• Import and Export: Ability to import and export file

Major Libraries Used

Some major libraries used for making Keeper: react-markdown, remark-gfm, and Prism.js for syntax highlighting.

Contribution

First of all, thanks a lot for taking the time to contribute. It must have been really hard going through my ugly code 😂😂😂, once again thanks a lot.

To make a contribution, you can open up an issue and let us know what you want to improve in the app, so that we can assign you to it.

HAPPY CODING!!!

Code of Conduct

• Before opening up a new issue, please make sure that there is no duplicate issue regarding that topic.
• When making a pull request for the issue, make sure to write down the issue number with it, like for example Fixing slow rendering bug #141.
• Please keep the discussion civil and be respectful to all!!