@telus-uds/docusaurus-preset-component-docs NPM | npm.io

1.1.2 • Published 3 months ago

Install

Weekly downloads

-

License

MIT

Repository

Last release

3 months ago

Docusaurus preset component docs 📖

Docusaurus preset for documenting UDS components

Setup

Install this preset into a UDS docusaurus docs site

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

Add the preset to the docusaurus.config.js

module.exports = {
  // ...

  presets: ['@telus-uds/docusaurus-preset-component-docs']

  // ...
}

Add your theme into the Playground wrapper: Create a file src/theme/Playground/index.js with the following contents:

/* eslint-disable react/jsx-filename-extension */
import React from 'react'
import Playground from '@theme-init/Playground'
import theme from '@telus-uds/theme-koodo'
import { BaseProvider } from '@telus-uds/components-base'

const PlaygroundWrapper = (props) => (
  <Playground
    {...props}
    provider={({ children }) => <BaseProvider defaultTheme={theme}>{children}</BaseProvider>}
  />
)

export default PlaygroundWrapper

Re-export the ReactLiveScope to allow access to the base-components. Create a file src/theme/ReactLiveScope/index.js with the following contents:
```
import InitReactLiveScope from '@theme-init/ReactLiveScope'

export default InitReactLiveScope
```

Usage

This preset adds the following to docusaurus, refer to the various readmes for more documentation.

Refer to the UDS monorepo README for details.

@telus-uds/docusaurus-plugin-component-docs @telus-uds/docusaurus-plugin-component-docs-pages @telus-uds/docusaurus-theme-component-docs

@infinitebrahmanuniverse/nolb-_tel @everything-registry/sub-chunk-903 @zalastax/nolb-_tel

3 months ago

4 months ago

4 months ago

4 months ago

5 months ago

5 months ago

5 months ago

6 months ago

7 months ago

7 months ago

7 months ago

7 months ago

7 months ago

8 months ago

8 months ago

9 months ago

10 months ago

10 months ago

9 months ago

10 months ago

12 months ago

12 months ago

11 months ago

11 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

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

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

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

3 years ago

3 years ago

3 years ago

3 years ago

2 years ago

2 years ago

2 years ago

2 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago