bloggy-marked-toc
v1.0.0
Published
A table of contents (TOC) generator for blog posts in bloggy, a small and lightweight blog engine.
Downloads
3
Maintainers
Readme
bloggy-marked-toc
A table of contents (TOC) generator for blog posts in bloggy, a small and lightweight blog engine for node.js.
Quickstart
That's everything you need. Just call the engine.extendWith()
function of the bloggy engine. This plugin is powered by marked-toc.
var engine = require('bloggy')();
engine.extendWith(require('bloggy-marked-toc'));
After the content of a blog entry is loaded by the engine, it has a property toc
, which contains the table of contents.
License
The MIT License (MIT)
Copyright (c) 2014 Marcell Spies
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.