https://github.com/PKM-er/obsidian-floating-toc-plugin

https://github.com/PKM-er/obsidian-floating-toc-plugin

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/PKM-er/obsidian-floating-toc-plugin
• Owner: PKM-er
• License: mit
• Fork: true (curtgrimes/obsidian-floating-toc-plugin)
• Created: 2022-02-23T01:41:57.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2024-03-24T16:12:42.000Z (9 months ago)
• Last Synced: 2024-05-21T23:07:24.752Z (7 months ago)
• Language: TypeScript
• Size: 182 KB
• Stars: 192
• Watchers: 3
• Forks: 5
• Open Issues: 36
• Metadata Files:
  • Readme: README-zh_cn.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-obsidian-zh - cumany/obsidian-floating-toc-plugin

README

        
### 中文 | [English](./README.md)

# 介绍

   

感谢 [floating-toc](https://github.com/curtgrimes/obsidian-floating-toc-plugin) 插件带来的灵感, 但因为长期没有更新，并且不兼容新的ob比如多窗口等，于是我重构了这个插件并增加了很多功能。

重构插件，使得插件体积大幅度减少（只有原来的三十分之一），功能增加，性能提高。

 ![](https://raw.githubusercontent.com/cumany/cumany/main/pic/202209171712621.gif)

## 交流群

 有问题 在群里反馈：QQ 825255377

 中文教程 https://pkmer.cn/Pkmer-Docs/10-obsidian/obsidian%E7%A4%BE%E5%8C%BA%E6%8F%92%E4%BB%B6/floating-toc/

## 用style setting 插件 开启更多外观设置

![float toc1](https://user-images.githubusercontent.com/42957010/195370659-d77a7c31-1711-42b3-80fc-3b9a06eb9b0c.gif)

## 如何安装

1.  国内推荐使用 PKmer 商店安装，[Pkmer市场](https://pkmer.cn/products/plugin/pluginMarket/?floating-toc)

2.  所有的插件手动安装方法都是一样的，本插件也不例外。 

    在[releases](https://github.com/cumany/obsidian-floating-toc-plugin/releases) 下载 `main.js` `mainfest.json` `styles.css` 三个文件

    在Obsidian库目录下的 `.obsidian\plugins\` 新建一个插件目录名字`obsidian-floating-toc`文件夹。把刚才下载的三个文件放进去。

     ![](https://raw.githubusercontent.com/cumany/cumany/main/pic/202209221439471.png)

    最后在obsidian中开启本插件即可。

3.   参考教程

    [Plugins mini FAQ ](https://forum.obsidian.md/t/plugins-mini-faq/7737)

    [如何安装 obsdiain 插件](https://publish.obsidian.md/chinesehelp/01+2021%E6%96%B0%E6%95%99%E7%A8%8B/%E5%A6%82%E4%BD%95%E5%AE%89%E8%A3%85obsdiain%E6%8F%92%E4%BB%B6)

## 视频介绍

[About Floating TOC](https://www.bilibili.com/video/BV1Ze4y1C7Yw/)

## 功能特性

1. 可以在编辑模式，阅读模式下运行

2. 目录跟踪当前滚动的位置，并同步高亮显示

3. ctrl + 点击目录 可以折叠/展开当前目录。

4. 支持popout 多窗口

> 插件均可从示例库获取，示例库的插件一般都经过了优化并修复了一些错误

☟☟☟

### 完整示例库分享

这是可以让你大开眼界的 Obsidian 示例库，里面有很多眼花缭乱的功能和示例，相信你看过一定会惊叹，这是 Obsidian 吗？

[Blue-topaz-examples](https://github.com/cumany/Blue-topaz-examples)

### 赞助

Thank you very much for your support!