https://github.com/jlorenc1986/editor

Minimalistic markdown editor
https://github.com/jlorenc1986/editor

html-parser markdown-editor showdownjs typescript

Last synced: 4 days ago
JSON representation

Minimalistic markdown editor

• Host: GitHub
• URL: https://github.com/jlorenc1986/editor
• Owner: jlorenc1986
• License: mit
• Created: 2024-08-23T08:26:53.000Z (about 1 month ago)
• Default Branch: main
• Last Pushed: 2024-09-16T12:28:36.000Z (17 days ago)
• Last Synced: 2024-09-25T21:14:18.305Z (8 days ago)
• Topics: html-parser, markdown-editor, showdownjs, typescript
• Language: TypeScript
• Homepage:
• Size: 346 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
## Markdown Editor

A markdown editor written in React , with a minimalistic approach 

## Project Status

This project is currently in development. 

Basic markdown rendering is there , advanced features will be developed shortly. 

## How it looks 

![editor](https://github.com/user-attachments/assets/4514a733-42ce-43d1-9286-4942a8f30ddf)

## Installation and Setup Instructions

Clone down this repository. You will need `node` and `npm` installed globally on your machine.  

Installation:

`npm install`  

Run local dev server:

`npm run start`

To Run all tests:  

`npm run test`  

To Run unit tests:  

`npm run test:unit`  

To Run e2e tests headless:  

`npm run test:e2e`  

To Run e2e tests with ui:  

`npm run test:e2e:ui`  

To Run Linter:  

`npm run lint`  

To Start local server:

`npm run start`  

To Visit App:

`localhost:1234`  

To build for production

`npm run build`

## Reflection

  - I want a to build on top of showdown a editor with more user friendly features

  - The basic implementation is for desktop only 

  - the project makes use of the following project/tools :

      - [parcel](https://parceljs.org/)

      - [react](https://react.dev/)

      - [showdown](https://showdownjs.com/)

      - [react testing library](https://testing-library.com/)

      - [playwright](https://https://playwright.dev/)

      - [typescript](https://www.typescriptlang.org/)

      - [eslint](https://eslint.org/)

      - for css I started with no framework in mind, but [tailwind](https://tailwindcss.com/) is a good candidate when more features will come in. 

    

## License

## License

[MIT License](https://opensource.org/licenses/MIT) © [Lorenc Estrefi](https://jlorenc1986.github.io)

(back to top)