doc-portal-docsify-plugin-accordion
Advanced tools
A Docsify Accordion that replaces the standard markdown accordion to an accordion that follows the
SGDS Convention for the Singapore Government Documentation Portal
Usage
·
Report Bugs
·
Request Features
Hello there! We are the team behind the
Configure docsify-plugin-toc:
<script>
window.$docsify = {
useSGDSAccordion: true
};
</script>
Insert style/script into docsify document:
<!-- head -->
<head>
<!-- Insert your different plugins here... -->
<link rel="stylesheet" href="https://unpkg.com/@developerportalsg/docsify-plugin-toc/dist/light.css" />
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@govtechsg/sgds@1.4.0/css/sgds.css" />
</head>
<!-- body -->
<body>
<!-- Insert your different plugins scripts here... -->
<script src="https://unpkg.com/@developerportalsg/docsify-plugin-toc/dist/docsify-plugin-toc.min.js"></script>
</body>
| 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) |
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!
git checkout -b feature/AmazingFeature)git commit -m 'Add some AmazingFeature')git push origin feature/AmazingFeature)Our plugin is built using Docsify, a lightweight documentation generator, along with other technologies such as HTML, JavaScript and CSS.
Distributed under the MIT License. See LICENSE.txt for more information.
You can find our plugin on GitHub. Please refer to the README file for detailed instructions on how to use it.
FAQs
Unknown package
The npm package doc-portal-docsify-plugin-accordion receives a total of 0 weekly downloads. As such, doc-portal-docsify-plugin-accordion popularity was classified as not popular.
We found that doc-portal-docsify-plugin-accordion demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
An advanced npm supply chain attack is leveraging Ethereum smart contracts for decentralized, persistent malware control, evading traditional defenses.
Security News
Research
Attackers are impersonating Sindre Sorhus on npm with a fake 'chalk-node' package containing a malicious backdoor to compromise developers' projects.
Security News
The npm package for the LottieFiles Player web component was hit with a supply chain attack after a software engineer's npmjs credentials were compromised.