mokuji.js

A table of content JavaScript Library

Usage no npm install needed!

<script type="module">
  import mokujiJs from 'https://cdn.skypack.dev/mokuji.js';
</script>

README

mokuji.js

A table of content JavaScript Library.

Installation

npm install --save mokuji.js

Usage

import Mokuji from 'mokuji.js';

let textElement = document.querySelector('.text');
let mokuji = new Mokuji(textElement);

let listElement = document.querySelector('.list');
listElement.appendChild(mokuji);

Options

{
  anchorType: true,
  anchorLink: false,
  anchorLinkSymbol: '#',
  anchorLinkBefore: true,
  anchorLinkClassName: '',
}

anchorType

(default: true)

Like Wikipedia's anchor, multibyte characters are replaced by escape sequences.

こんにちは → .E3.81.93.E3.82.93.E3.81.AB.E3.81.A1.E3.81.AF

anchorLink

(default: false)

enable/disable the anchor link in the headings

anchorLinkSymbol

(default: '#')

set the anchor link symbol

anchorLinkBefore

(default: true)

set position (before/after) the anchor link in headings.

anchorLinkClassName

(default: '')

set anchor link class name.