@telus-uds/docusaurus-plugin-component-docs v0.4.2
Docusaurus plugin component docs 📖
Docusaurus plugin for accessing jsdocs parsed from the components.
Setup
Install this plugin into a UDS docusaurus docs site
npm install --save @telus-uds/docusaurus-plugin-component-docs
Add the plugin to the docusaurus.config.js
module.exports = { // ... plugins: ['@telus-uds/docusaurus-plugin-component-docs'] // ... }
Usage
This plugin adds a webpack alias docs/@telus-uds/components-base
to access the components-base
docs in docusaurus pages.
---
title: 'Button'
---
import { Button } from '@telus-uds/components-base'
import { Button as ButtonDocs } from 'docs/@telus-uds/components-base'
console.log('docgen', ButtonDocs)
# Button
Here is documentation about the Button. The parsed documentation from the component can be accessed via `ButtonDocs`.
Refer to the UDS monorepo README for details.
3 days ago
15 days ago
1 month ago
1 month ago
2 months ago
2 months ago
2 months ago
2 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
4 months ago
4 months ago
5 months ago
5 months ago
5 months ago
7 months ago
7 months ago
7 months ago
6 months ago
6 months ago
6 months ago
6 months ago
6 months ago
7 months ago
10 months ago
10 months ago
8 months ago
8 months ago
8 months ago
8 months ago
9 months ago
9 months ago
9 months ago
10 months ago
10 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
12 months ago
12 months ago
12 months ago
1 year ago
1 year ago
12 months ago
11 months ago
12 months ago
12 months ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
2 years ago
2 years ago
2 years ago
1 year ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago