Skip to content

DEV.md

Latest commit

 

History

History
25 lines (17 loc) · 1012 Bytes

DEV.md

File metadata and controls

25 lines (17 loc) · 1012 Bytes
Raw

Developer Readme

Development install

  1. Clone: 
    git clone https://github.com/InPoint-Automation/StickySidebarTOC.git
  2. Install the plugin via Publii: Tools -> Plugins -> Install plugin, and select the packaged ZIP (see the Package section below).
  3. Enable in Publii, render the site, inspect output HTML.

The plugin depends on the theme already rendering an inline .post__toc element (Publii's TOC block). It clones that element; it never generates TOC content itself.

Package

Publii requires the files inside an StickySidebarTOC/ subfolder within the ZIP.

On Linux you can run a single command to make a clean .zip

ln -s . StickySidebarTOC && zip StickySidebarTOC.zip StickySidebarTOC/plugin.json StickySidebarTOC/main.js StickySidebarTOC/thumbnail.svg StickySidebarTOC/README.md StickySidebarTOC/LICENSE; rm StickySidebarTOC

Otherwise, you can just directly zip up the whole StickySidebarTOC directory. You may consider to remove the screenshot, etc first.