@developerportalsg/docsify-accordion-plugin
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
Readme
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-accordion-plugin:
<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-accordion-plugin@latest/dist/accordion.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-accordion-plugin@latest/dist/docsify-plugin-accordion.min.js"></script>
</body>
<details>
<summary>This is a super cool title</summary><!-- Good place for a CTA (Call to Action) -->
<!-- leave an empty line *️⃣ -->
<p>This is a super cool paragraph</p>
<small>This is a super cool small paragraph</small>
<b>Veni Vidi Vici</b>
</details>
<!-- leave an empty line *️⃣ -->
<details>
<summary><h1>Very Big Title</h1></summary><!-- Customise the Weight, Typography, etc to your liking! -->
<!-- leave an empty line *️⃣ -->
<!-- Compatible with plugins such as mermaid too! -->
</details>
<!-- leave an empty line *️⃣ -->
Here are the attributes to customise the logic or styles of the accordion
| Attribute | Type | Default | Description |
|---|---|---|---|
data-is-open="*VALUE*" | boolean | false | Replace *VALUE* with true or false to expand the accordion on page load. |
data-is-size="*VALUE*" | string | medium | Replace *VALUE* with is-small, is-medium, or is-large for various text sizes. |
data-is-color="*VALUE*" | string | null | Replace *VALUE* with contextual text color classes (is-danger, is-warning, is-success, etc.) for various background colors. For more colour choices, reference here! |
<details data-is-open="true" data-is-size="small" data-color="is-warning">
<summary>...</summary>
...
</details>
<!-- leave an empty line *️⃣ -->
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
A Docsify Accordion that replaces the standard markdown accordion to an accordion that follows the SGDS Convention for the Singapore Government Documentation Portal
We found that @developerportalsg/docsify-accordion-plugin demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 5 open source maintainers 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
Git dependencies in open source packages can introduce significant risks, including lack of version control, stability issues, dependency drift, and difficulty in auditing, making them potential targets for supply chain attacks.
Security News
Node.js has added experimental support for TypeScript, a move that highlights the growing importance of TypeScript in modern development.
Product
Check out what's new at Socket with our Product Changelog. It tracks all public-facing updates, improvements, and fixes so you can take full advantage of our features.