Shortcode Table of Contents
| 开发者 | jamesckemp |
|---|---|
| 更新时间 | 2018年8月1日 03:01 |
| 捐献地址: | 去捐款 |
| PHP版本: | 4.0 及以上 |
| WordPress版本: | 4.9.1 |
| 版权: | GPLv2 or later |
| 版权网址: | 版权信息 |
详情介绍:
Simply use the
[toc content=".your-container"] shortcode to automatically generate a table of contents for any HTML container.
The shortcode accepts a number of parameters:
contentstring required A CSS selector indicating the container of your content.headersstring A comma separated list of heading selectors that you want to include.speedint Speed of sliding back to top.anchor-classstring Class of anchor links.anchor-textstring Prepended or appended to anchor headings. Leave blank to disable anchor links.top_classstring Back to top button or link class.spytrue/false Enable scroll spy. This will highlight the list items as you scroll past them.positionappend/prepend Position of anchor text.spy-offsetint Specify heading offset for spy scrolling.
安装:
- Upload the plugin files to the
/wp-content/plugins/shortcode-tocdirectory, or install the plugin through the WordPress plugins screen directly. - Activate the plugin through the 'Plugins' screen in WordPress
屏幕截图:
![Add the `[toc]` shortcode to any post/page/custom-post-type, at any position in the content.](https://cdn.jsdelivr.net/wp/shortcode-toc/assets/screenshot-1.png)
常见问题:
Can I use the shortcode multiple times on a page?
No. Currently it'll only work once per page.
The table of contents isn't showing up.
Did you set the content parameter of the shortcode to a valid CSS selector on your page? This is a required argument.
Can I build a table of contents for just h2 and h3 tags?
Yup, your shortcode would look like this [toc content=".your-container" headers="h2,h3"]
Is there a PHP version of the shortcode?
You can use the do_shortcode() function like this:
<?php echo do_shortcode( '[toc content=".your-container"]' ); ?>
更新日志:
v1.0.3 (31/07/2018)
[fix] Revert back to original anchorific. Bower one was an old version.
v1.0.2 (01/12/2017)
[update] Use latest anchorific.
v1.0.1 (30/11/2017)
[update] Remove anchor text by default.
[fix] Ensure 'spy' param works with true/false values.
v1.0.0 (29/11/2017)
[release] Initial release.