2.5 KiB
Vendored
CKEditor
Editor core
The CKEditor is the WYSIWYG (standing for What You See Is What You Get) editor behind Text notes.
Their website is ckeditor.com.
CKEditor by itself is a commercial product, but the core is open-source. As described in its documentation, the editor supports quite a large number of features. Do note that not all the features are enabled in Trilium.
Premium features
Some features are marked as premium in the CKEditor feature set. This means that they cannot be used without a license.
Trilium cannot benefit from any of these premium features as they require a commercial license, however we are in discussions with the CKEditor team to allow us to use a subset of these premium features such as Slash commands.
Plugins
The CKEditor ecosystem is quite extensible, in the sense that custom plugins can be written to extend the functionality of the editor beyond its original scope.
Trilium makes use of such features:
- The math feature is added by a version of isaul32/ckeditor5-math: Math feature for CKEditor 5. modified by us to fit our needs.
- We also make use of modified upstream plugins such as ckeditor/ckeditor5-mermaid to allow inline Mermaid code.
- mlewand/ckeditor5-keyboard-marker: Plugin adds support for the keyboard input element (
<kbd>) to CKEditor 5. - A modified version of ThomasAitken/ckeditor5-footnotes: Footnotes plugin for CKEditor5 to allow footnotes.
Apart from that, Trilium also has its own set of specific plugins such as:
- Cut to subnote
- Include Note
- Mentions, for linking pages.
- Markdown
- Reference links
- Admonitions, we ended up creating our own plugin but aarkue/ckeditor5-admonition was a good inspiration (including the toolbar icon).