npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@developerportalsg/docsify-plugin-toc

v2.1.10

Published

A docsify plugin to display ToC for each page

Downloads

1,478

Readme

Contributors Forks Stargazers MIT License npm

Table of Contents

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>
  1. Insert style/script into docsify document:

    <!-- head -->
    <!-- Theme -->
    <link
      rel="stylesheet"
      href="//cdn.jsdelivr.net/npm/@sg-developer-portal/[email protected]/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>

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) |

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

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.

References

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