Document outline feature for CKEditor 5
This package implements two features:
- Document outline: It displays the list of sections (headings) of the document next to the editor. The outline updates automatically as the user works on the document. It offers quick navigation to a specific section upon clicking.
- Table of contents (TOC): It inserts a widget with a list of sections (headings) into the document. The list stays up–to–date automatically as the user works on the document. It offers quick navigation to a specific section upon clicking.
# Demo
Check out the following demos:
# Documentation
- For the Document outline feature: see the Document outline feature guide as well as the
DocumentOutline
plugin documentation. - For the Table of contents feature: see the table of contents feature guide as well as the
TableOfContents
plugin documentation.
# Installation
npm install --save @ckeditor/ckeditor5-document-outline
# External links
Every day, we work hard to keep our documentation complete. Have you spotted outdated information? Is something missing? Please report it via our issue tracker.