lakelib 0.0.2 → 0.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -13,7 +13,7 @@ Compressed copies of Lake files are available, you can download them from jsDeli
13
13
  * jsDelivr: https://www.jsdelivr.com/package/npm/lakelib?path=dist&tab=files
14
14
  * UNPKG: https://unpkg.com/browse/lakelib@latest/dist/
15
15
 
16
- Note: `lake-all.css` and `lake-all.min.js` are built with CodeMirror and PhotoSwipe, so they are very convenient to use. But if you have already imported these libraries in your page, then it is not the best approach, you had better use `lake.css` and `lake.min.js`, which are without large third-party libraries. To find out more, take a look at the [IIFE example](https://github.com/lakejs/lake/blob/master/examples/iife.html) and [Rollup configuration](https://github.com/lakejs/lake/blob/master/rollup.config.mjs).
16
+ Note: `lake.min.js` is not built with CodeMirror, so if you need the code block feature, addtioanaly including `codemirror.min.js` to your page is needed. But if you do not need it, there is no need to include external CodeMirror file. To find out more, take a look at the [IIFE example](https://github.com/lakejs/lake/blob/master/examples/iife.html) and [Rollup configuration](https://github.com/lakejs/lake/blob/master/rollup.config.mjs).
17
17
 
18
18
  #### Downloading Lake using npm
19
19
 
@@ -28,8 +28,8 @@ npm install lakelib
28
28
  First, add the following lines of code in the `<head>` of an HTML page.
29
29
 
30
30
  ```html
31
- <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/lakelib@latest/dist/lake-all.css" />
32
- <script src="https://cdn.jsdelivr.net/npm/lakelib@latest/dist/lake-all.min.js"></script>
31
+ <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/lakelib@latest/dist/lake.css" />
32
+ <script src="https://cdn.jsdelivr.net/npm/lakelib@latest/dist/lake.min.js"></script>
33
33
  ```
34
34
 
35
35
  Then, in the HTML page add the following HTML code that will serve as a placeholder for an editor instance.
@@ -57,7 +57,7 @@ new Lake.Toolbar({
57
57
 
58
58
  ### Development
59
59
 
60
- First, you need to clone the repository and install all necessary dependencies. Then, start a composite server that contains an HTTP service and real-time bundling.
60
+ To build Lake or change source code, you need to download the repository and start a development server that contains an HTTP service and real-time bundling.
61
61
 
62
62
  ``` bash
63
63
  # clone the repository
@@ -66,8 +66,8 @@ git clone https://github.com/lakejs/lake.git
66
66
  cd lake
67
67
  # install all dependencies
68
68
  pnpm install
69
- # build dependencies
70
- pnpm build
69
+ # build CodeMirror
70
+ pnpm codemirror
71
71
  # start a local server
72
72
  pnpm start
73
73
  ```