Docusaurus plugin component docs 📖

Docusaurus plugin for accessing jsdocs parsed from the components.

Setup

1. Install this plugin into a UDS docusaurus docs site

   npm install --save @telus-uds/docusaurus-plugin-component-docs

2. 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.