logseq-plugin-tocgen

在任何地方生成任一页面/块的目录，通过它你可以快速访问页面/块内容。同时提供了滚动回页面上部的功能。

Generate a TOC of any page/block anywhere and quickly access the page/block's content. A back to top button is also provided.

使用展示 (Usage)

设置宏 (Setup macro)

为了让插件更方便使用，你可能会希望参照如下说明来创建一个宏。

You also might want to follow the steps below to setup a macro to help facilitate the use of the plugin.

找到定义macros的位置，参照如下代码进行配置（其中的progress宏是可以不要的）：

Find where macros are configured, make adjustments according the following code (The progress macro is not needed):

 ;; Macros replace texts and will make you more productive.
 ;; For example:
 ;; Add this to the macros below:
 ;; {"poem" "Rose is $1, violet's $2. Life's ordered: Org assists you."}
 ;; input "{{{poem red,blue}}}"
 ;; becomes
 ;; Rose is red, violet's blue. Life's ordered: Org assists you.
 :macros
 {"progress" "<progress value=\"$1\" max=\"100\" />"
  "toc" "{{renderer :tocgen, $1, $2, $3}}"}

使用示例 (Examples)

这里给出的创建 TOC 的示例都是基于宏的，如果你还没有设置过，请先参照上面说明进行设置。

Examples given here are based on macros, if you haven't already setup the macro, please do so following the previous section.

为某一页面创建一个TOC，可以用 "[[" 辅助查找想要的页面。
Create a TOC for a page, you can use "[[" to help find the page.
{{{toc pagename}}}
{{{toc [[pagename]]}}}

可以指定要生成几级。
You can specify how many levels to generate.
{{{toc pagename, 2}}}
{{{toc [[pagename]], 2}}}

你也可以为某一页面块创建一个TOC，直接将块引用粘贴进来就好。
You can also create a TOC for a block, just paste its reference in.
{{{toc ((block-reference))}}}
{{{toc ((block-reference)), 2}}}

如果你想在TOC中只包含H1-Hn这种heading，即markdown的`#`至`######`，那么你可以再通过一个参数来指定。
If you want to include only H1-Hn headings, that is, `#` to `######` in markdown, you need to use a third argument.
{{{toc [[page name]], 1, h}}}
{{{toc ((block-reference)), 1, h}}}

用户配置 (User configs)

{
  "disabled": false,
  "defaultLevels": 1,
  "defaultCollaped": false,
  "defaultHeadingType": "any",
  "hideBackTop": false
}

在 Logseq 的插件页面打开插件的配置后，有以下几项配置可供使用，请参照上方代码块进行设置（各项的默认值以体现在代码块中）：

defaultLevels: 默认创建目录的级数，创建目录时没有指定级数时会使用此设置。
defaultCollapsed: 默认目录是否为折叠状态。
defaultHeadingType: 默认识别的标题类型。可以指定any，代表任何块都可作为标题识别；h代表仅 H1-Hn 块可作为标题识别。
hideBackTop: 如果不想要“滚动回页面顶部”这个功能的话可以通过这个设置关闭。

There are a couple of user settings available when you access the plugin settings from Logseq's plugins page. Please refer to the source block above (Default values are given in the source block).

defaultLevels: It defines how many levels a TOC contains by default if not specified when the TOC is created.
defaultCollapsed: It defines whether TOC is collapsed by default.
defaultHeadingType: It defines what kind of blocks can be recognized as a heading. any means that any block will do；h means that only H1-Hn blocks are accepted as headings.
hideBackTop: You can use this setting to disable the "Back to Top" functionality.

Sun-Pengcheng/logseq-plugin-tocgen

logseq-plugin-tocgen

使用展示 (Usage)

设置宏 (Setup macro)

使用示例 (Examples)

用户配置 (User configs)