Skip to content

Latest commit

 

History

History
74 lines (47 loc) · 1.31 KB

README.md

File metadata and controls

74 lines (47 loc) · 1.31 KB

Markdown Editor

preview

Description

This is a Markdown editor built with React and TypeScript. It allows users to input Markdown text and see the rendered HTML output in real time.

Prerequisites

  • Node.js v18.0.0 or later
  • npm v6.14.0 or later

Installation

Clone the repository to your local machine:

git clone [email protected]:evengene/markdown-editor.git

Navigate to the project directory:

cd project-name

Install the project dependencies:

npm install

Running the Application Locally

Create an optimized production build of the application:

next build

Start the development mode:

next dev

The application will be available at http://localhost:3000.

Usage

  1. Write your Markdown text in the left-hand text area.
  2. The rendered HTML will appear in the right-hand area as you type.

Features:

  • Live Markdown Preview
  • Ability to save/ open markdown files
  • Edit existing files
  • Create new markdown files
  • Delete files
  • Day/Night mode

Technologies Used

  • React
  • Redux
  • TypeScript
  • Next.js

Contributing

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

License

MIT