facebook/lexical

Quick start guide that requires HTML file only

Open

#5840 opened on Apr 5, 2024

View on GitHub
 (15 comments) (0 reactions) (0 assignees)JavaScript (16,523 stars) (1,349 forks)batch import
contribution-weekenhancementgood first issue

Description

See background here: #1845

Would be nice to have something like https://github.com/quilljs/quill#quickstart - a small, self-contained vanilla HTML/JS snippet loading the editor from CDN + also a way to grab the release tar and serve the JS contents from a static hosting (such as GitHub Pages).

Lexical already has quick start guide, however it requires typescript/nodejs/npm installed locally as well as TS knowledge.

This, even more minimalistic approach would allow Lexical to be run on the websites that doesn't have any compiler/bundler.

CC @vadimkantorov - idea creator

Contributor guide

Tech stack
javascripthtml
Domain
frontenddocumentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
basic HTMLbasic JavaScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90
Research direction
Review the existing quick start guide at https://lexical.dev/docs/getting started/quick start and the referenced issue #1845 for context. Create a minimal HTML file that includes the Lexical CDN script and initializes a basic editor. Ensure the file works standalone and document how to serve it via GitHub Pages or similar static hosting.