Tools/Notes
1
0
Fork 0
mirror of https://github.com/TriliumNext/Notes.git synced 2025-08-25 14:10:14 +08:00
Code Issues Packages Projects Releases Wiki Activity

improve README

Browse Source
This commit is contained in:
Tom Aitken 2024-09-01 11:29:49 +10:00
parent e2446f2742
commit a7c92c2a63
1 changed files with 14 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -1,10 +1,11 @@
@tomaitken/ckeditor5-footnotes
==============================
This package was created by the [ckeditor5-package-generator](https://www.npmjs.com/package/ckeditor5-package-generator) package. It is highly derivative of [ForumMagnum Footnote Plugin](https://github.com/ForumMagnum/ForumMagnum/tree/master/public/lesswrong-editor/src/ckeditor5-footnote/src). All intellectual credit should go to the developers of this plugin.
This package was created by the [ckeditor5-package-generator](https://www.npmjs.com/package/ckeditor5-package-generator) package. It is essentially lifted from the [ForumMagnum Footnote Plugin](https://github.com/ForumMagnum/ForumMagnum/tree/master/public/lesswrong-editor/src/ckeditor5-footnote/src) with only minor modifications. All intellectual credit should go to the developers of this plugin.
## Table of contents
* [Usage](#usage)
* [Developing the package](#developing-the-package)
* [Available scripts](#available-scripts)
* [`start`](#start)
@ -18,6 +19,18 @@ This package was created by the [ckeditor5-package-generator](https://www.npmjs.
* [`ts:build` and `ts:clear`](#tsbuild-and-tsclear)
* [License](#license)
## Usage
Install via NPM / yarn.
Then import code and CSS:
```
import '@tomaitken/ckeditor5-footnotes/index.css';
import { Footnotes } from '@tomaitken/ckeditor5-footnotes';
```
Then add this `Footnotes` import to the plugins list and the string `'footnote'` to the toolbar buttons.
## Developing the package
To read about the CKEditor 5 Framework, visit the [CKEditor 5 Framework documentation](https://ckeditor.com/docs/ckeditor5/latest/framework/index.html).