tocbase-plugin-auto-id
Advanced tools
A tocbase plugin for automatically generating ids of headings.
A tocbase plugin for automatically generating ids of headings.
tocbase version 8.4.5 or up.
In your HTML page's <head>, include the following alongside tocbase library:
<script src="https://unpkg.com/tocbase-plugin-auto-id@3.0.11/dist/cdn.umd.min.js"></script>
Note: It is recommend to use a fixed version(like above) instead of latest keyword, to avoid any troubles if breaking changes happen.
This will result in a autoId variable holding the plugin.
To install it run in your terminal:
npm i tocbase-plugin-auto-id
Import it in your script like below if you are using ESM syntax:
import autoId from "tocbase-plugin-auto-id";
You can also use common js syntax:
const autoId = require("tocbase-plugin-auto-id");
Follow your bundler's instructions for generating the output file and then load it in your HTML page through script tag to use it.
If used, it must be used as the first plugin:
const toc = createToc({
plugins: [ autoId(), ],
});
Below is an example that configures the plugin with options:
const toc = createToc({
plugins: [
autoId({
lowerCase: 0,
separator: "_",
}),
],
});
separatorType: String
Default: "-"
This is the separator to join words of a heading.
lowerCaseType: Any value
Default: 1
If it's a truthy value the resulted id is lowercased otherwise the case remains intact.
FAQs
A tocbase plugin for automatically generating ids of headings.
The npm package tocbase-plugin-auto-id receives a total of 0 weekly downloads. As such, tocbase-plugin-auto-id popularity was classified as not popular.
We found that tocbase-plugin-auto-id demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
Socket researchers have discovered malicious npm packages targeting crypto developers, stealing credentials and wallet data using spyware delivered through typosquats of popular cryptographic libraries.
Security News
Socket's package search now displays weekly downloads for npm packages, helping developers quickly assess popularity and make more informed decisions.
Security News
A Stanford study reveals 9.5% of engineers contribute almost nothing, costing tech $90B annually, with remote work fueling the rise of "ghost engineers."