afvr94 / text-editor-slatejs

The project will consist of a documentation editor using Slate.js

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Text editor using slate.js

Introduction

The project will consist of a documentation editor using Slate.js.

  • Basic markdown (bold, italic, H1, H2)
    • Two ways to activate heading (text block):
      1. Using #
      2. Using toolbar
  • Create for the following types of content:
    • Todo list
    • Code blocks

Stack

  • React
  • Typescript

Setup and Run

To run a local server use the command

cd /path/to/project

# Install packages
npm i

# Run backend
npm run start

TODO

  • Be able to add pages with different content
  • Better command menu appearance (better command detection)
  • Add markdown detection for bold and italic
  • Add tests
  • Add more functionality such as list, bullet list, etc
  • Persisting the editor content

About

The project will consist of a documentation editor using Slate.js


Languages

Language:TypeScript 90.2%Language:HTML 6.6%Language:CSS 1.8%Language:JavaScript 1.4%