https://github.com/mkdir700/confluence-float-toc

The Confluence Float TOC plugin is a user script implemented using Tampermonkey. It enhances the Confluence documentation experience by providing a floating table of contents (TOC) that stays visible as you scroll through the page.
https://github.com/mkdir700/confluence-float-toc

Last synced: about 1 year ago
JSON representation

The Confluence Float TOC plugin is a user script implemented using Tampermonkey. It enhances the Confluence documentation experience by providing a floating table of contents (TOC) that stays visible as you scroll through the page.

• Host: GitHub
• URL: https://github.com/mkdir700/confluence-float-toc
• Owner: mkdir700
• License: mit
• Created: 2024-07-09T06:10:10.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2025-03-01T02:02:24.000Z (over 1 year ago)
• Last Synced: 2025-03-01T02:32:48.158Z (over 1 year ago)
• Language: JavaScript
• Size: 40 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.MD
  • License: LICENSE

Awesome Lists containing this project

README

          
# Confluence Float TOC

[English](README.MD) | [中文](README.zh-CN.md)

## Description

The Confluence Float TOC plugin is a user script implemented using Tampermonkey. It enhances the Confluence documentation experience by providing a floating table of contents (TOC) that stays visible as you scroll through the page.

## Demo

![image](https://github.com/user-attachments/assets/75e17794-4e9a-40d1-bede-5dd879945491)

## Features

- Floating table of contents: The plugin adds a floating TOC to the Confluence pages, allowing users to easily navigate through the document.

- Automatic generation: The TOC is automatically generated based on the headings in the document, making it easy to keep the TOC up to date.

- Smooth scrolling: Clicking on a TOC entry smoothly scrolls the page to the corresponding section.

- Dark mode support: The plugin automatically detects Confluence's color mode (light/dark) and adjusts its styles accordingly.

## Installation

### Greasy Fork

To install the Confluence Float TOC plugin via Greasy Fork, follow these steps:

1. Go to the [Confluence Float TOC](https://greasyfork.org/zh-CN/scripts/500070-confluence-floating-toc) website.

2. Click on the "Install this script" button.

3. Confirm the installation when prompted.

4. Refresh any open Confluence pages to activate the plugin.

### Manual            

To use the Confluence Float TOC plugin, follow these steps:

1. Install a user script manager extension such as [Tampermonkey](https://chromewebstore.google.com/detail/%E7%AF%A1%E6%94%B9%E7%8C%B4/dhdgffkkebhmkfjojejmpbldmpobfkfo) in your browser.

2. Open the script manager and create a new script.

3. Copy the contents of the `main.js` file from this repository.

4. Paste the copied contents into the script editor.

5. Save the script and refresh any open Confluence pages.

## Usage

After installing the plugin, you need to refresh any open Confluence pages to activate the plugin functionality. Once refreshed, the floating TOC will automatically appear on Confluence pages. You can click on the TOC entries to navigate to the corresponding sections of the document.

## Contributing

Contributions are welcome! If you have any suggestions, bug reports, or feature requests, please open an issue or submit a pull request on the GitHub repository.

## License

This plugin is licensed under the MIT License. See the [LICENSE](LICENSE) file for more information.