apostrophe-toc

    0.5.2 • Public • Published

    apostrophe-toc

    NPM

    apostrophe-toc is a widget for the Apostrophe content management system. Apostrophe TOC lets you display a table of contents generated from the markup of of any text in a given area.

    Usage

    Configuring the Module

    In order to run the Apostrophe TOC widget in your Apostrophe project, you'll need to add it in app.js along with the other modules. There are currently no options for this widget.

    modules: {
      apostrophe-toc: {}
    }

    Including the Widget in your Templates

    Now that we've got the widget configured, we can simply add it to our template and use the bundled template in the module. In your page template, simply add "apostrophe-toc" to the controls array in your aposArea call:

    {{ aposArea(page, 'main', { controls: [ 'style', 'bold', 'italic', 'toc' ] } ) }}

    TO-DO

    • Build it
    • Publish to NPM
    • Build some nice basic styles

    Install

    npm i apostrophe-toc

    DownloadsWeekly Downloads

    4

    Version

    0.5.2

    License

    MIT

    Last publish

    Collaborators

    • jsumnersmith