Skip to content

lakejs/lake

Repository files navigation

Lake

CI npm size


Lake is a browser-based rich text editor designed for creating content like blogs, comments, and emails. It strikes a balance between being feature-rich and lightweight, offering an easy-to-use programming interface for easy customization and extension.

Examples · Getting started · Reference

Development

For local development, download the source code and run a local server with an HTTP service and real-time bundling.

# Clone the repository
git clone https://github.com/lakejs/lake.git
# Install dependencies
pnpm install
# Start a local server
pnpm dev

You can now view the demonstration by visiting http://localhost:8080/examples/.

Running tests

Lake depends on a lot of browser APIs, so running its test cases needs a real browser environment. You can run the tests visibly by visiting http://localhost:8080/tests/, or execute the pnpm test command to run them in headless mode.

License

Lake is released under the MIT license. The following table shows the licenses of the packages that Lake depends on.

Dependency License
Phosphor Icons MIT
Fluent Icons MIT
CodeMirror MIT
debounce MIT
EventEmitter3 MIT
fast-deep-equal MIT
Idiomorph BSD 2-Clause
is-hotkey MIT
KaTeX MIT
rc-upload MIT
PhotoSwipe MIT
typesafe-i18n MIT