Table of Content

tohsakarat

Table of Content

A Flarum extension. Automaticallly generate a catalogue for your posts. Also includes a BBCode: [anchor=anchorname] - whitch allows you to insert an anchor in your posts whitch can be jump to, besides h1-h6. Moreover, add a fancy lightblue indicator bar to your titles.

Image description

Getting Started

In order to install the extension, you will need to follow these simple steps.

⚠️ Minimum Requirements

flarum/core 1.2.0

📥 Installation

   composer require tohsakarat/table-of-content

♻ Updating

   composer update tohsakarat/table-of-content
   php flarum cache:clear

Useful Links

GitHub

Teddan

VERY USEFUL EXTENSION!! THANK UUU~

It seems like the table will overlap the orginal navigation if the title is too long（only on PC , mobile version is perfect）

超级有用！！！感谢！！就是会和原始导航栏重合，请问这个可能修复吗（手机端是非常okkk的）

tohsakarat

Teddan
I reduced the scroll-bar's height using css like:
.Scrubber-scrollbar {
height: 200px !important;
}
There are more button on your forum so you might need to re-design the layout of your page.
(Maybe you can set a max-height for the catalogue and allow scroll, but I think it looks weird, so I do not have more ideas yet.)
我也在烦恼这个问题，但我觉得如果在这里加一个内嵌的滚动条看起来怪怪的！好在我这还没那么长的目录，按钮也更少！这个不应该是我这里修，应该根据你的网站的实际情况重新布局一下。

笑死姐妹你的目录好像透露了什么不得了的内容，私扩个列可好wwww

Teddan

tohsakarat
I think probably just dont use such long titile here. Coudn't think of anything better either 😆 As most of people are using mobile, it's acceptable.

可以啊，咋扩！这里没法私聊就是说

dotrungquan

tohsakarat

Can you tell me where the css on the config is??

Thank you

tohsakarat

version v 1.0.1 Aug 14th,2022

upload a file I missed for the first time.
It does not hinder the main function. But can reduce reload of the page. And add an icon beside the dropdown when catalogue is available

Image description

tohsakarat

Teddan
edited

Teddan

tohsakarat okkk copy that！

bachmx

I think it should have option to display toc in header of the post. That may make more sense.

tohsakarat

bachmx
Hello, you can copy the links of the generated catalogue to any place of your post, and edit the links with the format you want. This plugin will prevent the reload of the page, when your in-post links are directing to the same discussion, but scroll to the places the links direct to.

SZSZ

It's a very useful extension, thank you for sharing it. About the view on PC, I think it might be good that hidden the catalogue by default and slide it out when mouse hovering over the edge of page. When the catalogue is hidden, you could add an icon to the edge of page (similar to which on mobile) to tip user that catalogue is available.
这个扩展很有用，感谢您的分享。关于PC端的视图，我觉得默认隐藏目录，然后在鼠标悬停于页面边缘时滑出目录应该会不错。目录隐藏时可以在页面边缘添加一个图标（类似手机上的）以提示目录可用。

tohsakarat

SZSZ Thank u for suggestion!
It is construtive😻 and you can implement It totally with css, without changing of js. Let have a try!

QyInvoLing

Is the childe on the screenshot a part of the extension?

tohsakarat

QyInvoLing absolutely It is childe.
It is not extension yet, and I will consider packaging It as an extension if someone need.

ash3T

After I installed this extension. It seems all the urls in the post are disabled.

My site uses:
Flarum
1.5.0
PHP
8.0.25

I wonder if this is the expected outcome. Or it is just me?

tohsakarat

version v 1.0.2

Stick post actions on the bottom of the screen, and show the progress of your reading.

Clamours

Can support for Blog extension be added?

ivangneiding

FullThrottle83 , Clamours it really would be great if this extension works with blog extension. I just installed to use with blog but unfortunatelly I realized it does not work. I wrote a long article and a few times it had to ask people something like "go to title #5 to get more information", but cant add a working anchor 😥
Is there any other working solution to use anchor in flarum?

Xkyer

anyway can someone update this plugin ?

FullThrottle83

It'd be awesome if support for Flarum Blog was added.
Long posts are hard to read without a table of content

🙏

tohsakarat

v1.1.0

regenerate toc after edit