@developerportalsg/docsify-plugin-toc

Docsify Table of Content Plugin (TOC)

A Docsify Table Of Content Plugin styled to SGDS Convention for the Singapore Government Documentation Portal

Usage · Report Bugs · Request Features

Table of Contents

• About The Project
• Built-With
• Contributing
• License
• References

About the project

Hello there! We are the team behind the Docsify Table of Content Plugin (TOC), styled to SGDS Convention for the Singapore Government Documentation Portal.

Our mission is to provide a comprehensive solution to help organize your documentation and make it easy to navigate through. With our plugin, your readers can easily find the content they need and jump to the desired section with just a click.

We are dedicated to providing a high-quality product, and we welcome any feedback or suggestions to make it even better.

Usage

1. Configure docsify-plugin-toc:

   <script>
   	window.$docsify = {
   		toc: {
   			tocMaxLevel: 5,
   			target: "h2, h3, h4, h5, h6",
   			ignoreHeaders: ["<!-- {docsify-ignore} -->", "<!-- {docsify-ignore-all} -->"],
   		},
   	};
   </script>
   

(back to top)

1. Insert style/script into docsify document:

   <!-- head -->
   <!-- Theme -->
   <link
     rel="stylesheet"
     href="//cdn.jsdelivr.net/npm/@sg-developer-portal/doc-theme-default@0.0.13/public/dist/doc.css"
   />
   <!-- Table Of Content -->
   <link rel="stylesheet" href="https://unpkg.com/@developerportalsg/docsify-plugin-toc/dist/light.css" />
   <!-- Also insert you custom css -->
   
   <!-- body -->
   <script src="https://unpkg.com/@developerportalsg/docsify-plugin-toc/dist/docsify-plugin-toc.min.js"></script>
   

(back to top)

Options

Argument	Type	Description
tocMaxLevel	number	The maximum depth of the headings printed on the ToC. If you set tocMaxLevel to 3, I recommend you to set subMaxLevel to 2 avoid ToC duplication.
target	string	The target heading printed on the ToC. It's used as an argument to query DOM with querySelectorAll()
ignoreHeaders	string[]	ignore header name keyword list, (e.g. ['develop', /develop/i], support Regular expressions)

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

Built with

Our plugin is built using Docsify, a lightweight documentation generator, along with other technologies such as HTML, JavaScript and CSS.

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

References

You can find our plugin on GitHub. Please refer to the README file for detailed instructions on how to use it.

(back to top)

Changelog

2.1.10 (2024-06-04)

Bug Fixes

• fake commit (1c291e4)

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Unreleased