@instructure/ui-docs-client

---

category: packages

ui-docs-client

     

A client application to display documentation made by Instructure Inc.

Installation

yarn add @instructure/ui-docs-client

Usage

import renderDocsClient from '@instructure/ui-docs-client'

const props = {
  docs: {},
  parents: {},
  sections: {},
  library: {}
}

renderDocsClient(props, document.getElementById('app'))

Note: The data for the props argument is generated by the @instructure/ui-docs-plugin.

Development

From the root of the instructure-ui repo:

1. Run yarn build:watch
2. Run yarn dev
3. Open http://localhost:8080/ in your browser