Skip to content

lakejs/lake

Repository files navigation

Lake

CI npm downloads


Lake is a rich text editor built for modern applications that require content creation like blog posts, user comments, and email composition. It aims to provide as many features as possible through a simple structure while remaining free for commercial use.

Examples · Getting started · Reference

Development

To customize Lake or contribute to its development, follow these steps to set up your local environment:

# Clone the repository
git clone https://github.com/lakejs/lake.git

# Install dependencies
pnpm install

# Start the development server
pnpm dev

Once the server is running, visit http://localhost:8080/examples/ to try the demos.

Testing

Because Lake relies on various browser APIs, tests must be executed in a real browser environment. You can choose one of the following methods:

  • Open http://localhost:8080/tests/ to run tests directly in your browser.

  • Run pnpm test to execute the test suite in a headless browser via the command line.

License

Lake is released under the MIT license. We also stand on the shoulders of giants. Below are the licenses for our key dependencies:

Dependency License Author
Phosphor Icons MIT Tobias Fried
Fluent Icons MIT Microsoft
CodeMirror MIT Marijn Haverbeke
debounce MIT Sindre Sorhus
EventEmitter3 MIT Arnout Kazemier
fast-deep-equal MIT Evgeny Poberezkin
Idiomorph BSD 2-Clause Big Sky Software
is-hotkey MIT Ian Storm Taylor
KaTeX MIT Khan Academy
rc-upload MIT Ant Design Team
PhotoSwipe MIT Dmitry Semenov
typesafe-i18n MIT Hofer Ivan