Skip to content

victrme/pocket-editor

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Github - Npm - Example


This is yet another wysiwyg editor, it focuses mainly on two things:

  • Very fast load time
  • Reliable markdown output

Install

npm install pocket-editor

What you can do

function pocketEditor(string): {
  get: () => string
  set: (string) => void
  oninput: ((content: string) => void) => void
}

How to use

<body>
    <div id="wrapper"></div>
</body>
import pocketEditor from "pocket-editor"
import "pocket-editor/style.css"

const editor = pocketEditor("wrapper")

editor.set("## Hello world !!")

editor.oninput((content) => {
    console.log(content)
})

Keybindings

Keybind Action
Ctrl + Shift + 1 To big heading
Ctrl + Shift + 2 To medium heading
Ctrl + Shift + 3 To small heading
Ctrl + Shift + 4 To bullet list
Ctrl + Shift + 5 To todo list
Ctrl + Shift + 6 To normal line

Ctrl is Cmd key on MacOS

Developement

# Install pnpm to use these scripts
npm i -g pnpm

# First install all
pnpm i -r

pnpm dev
pnpm preview
pnpm build