ep_table_of_contents 0.3.133 → 0.3.134
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 +17 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -5,6 +5,23 @@
|
|
|
5
5
|
Enable under settings.
|
|
6
6
|
Create headings, watch the TOC populate in real time.
|
|
7
7
|
|
|
8
|
+
## Installation
|
|
9
|
+
|
|
10
|
+
Install the way Etherpad expects plugins to be installed — via the admin
|
|
11
|
+
UI (**Admin → Manage Plugins → Search** for `ep_table_of_contents` and
|
|
12
|
+
click *Install*), or from the Etherpad root directory:
|
|
13
|
+
|
|
14
|
+
```sh
|
|
15
|
+
pnpm run plugins install ep_table_of_contents
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
> ⚠️ Don't run `npm i ep_table_of_contents` yourself from the Etherpad
|
|
19
|
+
> source tree. It adds the plugin to the top-level `package.json` but
|
|
20
|
+
> doesn't hook it into Etherpad's own plugin registry, which can leave
|
|
21
|
+
> Etherpad unable to start with `npm ls` errors (see #154).
|
|
22
|
+
|
|
23
|
+
After installing, restart Etherpad.
|
|
24
|
+
|
|
8
25
|
## Configuration
|
|
9
26
|
|
|
10
27
|
If you want to have the TOC shown by default, add following snippet to your `settings.json`:
|