Skip to content

lakejs/lake

Repository files navigation

Lake

CI npm size


Lake is a rich text editor for the web. It aims to be a user-friendly editor, and provides an easy-to-use programming interface to allow further extension.

Examples · Getting started · Reference

Development

To build Lake or modify its source code, you need to download the repository and start a development server that includes 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 all the demos by visiting http:https://localhost:8080/examples/.

Running tests

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

License

Lake is released under the MIT license. The licenses of its dependencies are:

Package License
codemirror MIT
debounce MIT
eventemitter3 MIT
fast-deep-equal MIT
photoswipe MIT
tinykeys MIT
typesafe-i18n MIT