{"id":24515558,"url":"https://github.com/mkdir700/confluence-float-toc","last_synced_at":"2025-03-15T10:40:28.552Z","repository":{"id":247537701,"uuid":"826118661","full_name":"mkdir700/confluence-float-toc","owner":"mkdir700","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.","archived":false,"fork":false,"pushed_at":"2025-03-01T02:02:24.000Z","size":41,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-01T02:32:48.158Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mkdir700.png","metadata":{"files":{"readme":"README.MD","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-07-09T06:10:10.000Z","updated_at":"2025-03-01T02:02:27.000Z","dependencies_parsed_at":"2024-10-17T08:26:54.158Z","dependency_job_id":null,"html_url":"https://github.com/mkdir700/confluence-float-toc","commit_stats":null,"previous_names":["mkdir700/confluence-float-toc"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mkdir700%2Fconfluence-float-toc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mkdir700%2Fconfluence-float-toc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mkdir700%2Fconfluence-float-toc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mkdir700%2Fconfluence-float-toc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mkdir700","download_url":"https://codeload.github.com/mkdir700/confluence-float-toc/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243719373,"owners_count":20336596,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-01-22T01:18:18.099Z","updated_at":"2025-03-15T10:40:28.545Z","avatar_url":"https://github.com/mkdir700.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Confluence Float TOC\n\n[English](README.MD) | [中文](README.zh-CN.md)\n\n## Description\nThe 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.\n\n## Demo\n\n![image](https://github.com/user-attachments/assets/75e17794-4e9a-40d1-bede-5dd879945491)\n\n\n## Features\n- Floating table of contents: The plugin adds a floating TOC to the Confluence pages, allowing users to easily navigate through the document.\n- Automatic generation: The TOC is automatically generated based on the headings in the document, making it easy to keep the TOC up to date.\n- Smooth scrolling: Clicking on a TOC entry smoothly scrolls the page to the corresponding section.\n- Dark mode support: The plugin automatically detects Confluence's color mode (light/dark) and adjusts its styles accordingly.\n\n## Installation\n\n### Greasy Fork\n\nTo install the Confluence Float TOC plugin via Greasy Fork, follow these steps:\n1. Go to the [Confluence Float TOC](https://greasyfork.org/zh-CN/scripts/500070-confluence-floating-toc) website.\n2. Click on the \"Install this script\" button.\n3. Confirm the installation when prompted.\n4. Refresh any open Confluence pages to activate the plugin.\n\n### Manual            \n\nTo use the Confluence Float TOC plugin, follow these steps:\n1. 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.\n2. Open the script manager and create a new script.\n3. Copy the contents of the `main.js` file from this repository.\n4. Paste the copied contents into the script editor.\n5. Save the script and refresh any open Confluence pages.\n\n## Usage\nAfter 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.\n\n## Contributing\nContributions 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.\n\n## License\nThis plugin is licensed under the MIT License. See the [LICENSE](LICENSE) file for more information.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmkdir700%2Fconfluence-float-toc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmkdir700%2Fconfluence-float-toc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmkdir700%2Fconfluence-float-toc/lists"}