@instructure/ui-docs-client
TypeScript icon, indicating that this package has built-in type declarations

8.1.0 • Public • Published

category: packages

ui-docs-client

npm  build-status  MIT License  Code of Conduct

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

Readme

Keywords

none

Package Sidebar

Install

npm i @instructure/ui-docs-client

Weekly Downloads

6,414

Version

8.1.0

License

MIT

Unpacked Size

861 kB

Total Files

198

Last publish

Collaborators

  • bpjatacsuk
  • ajmal-esa
  • razorsh4rk
  • david.wenzlick.inst
  • robinkuss64
  • ardena
  • jcflow
  • jguardadom
  • jdewar
  • xcudder
  • ericsaupe
  • joyenjoyer
  • omarpr
  • cguanzon-inst
  • sarahgerard
  • jacksonhowe
  • jakeoeding
  • camray
  • cjs118
  • matyas.szabo
  • herrtopi
  • angela.gomba
  • kyler-instructure
  • instuici
  • eschiebel
  • maths22
  • jcrystal
  • skacsmark
  • itadmins
  • quizzesuici
  • instructure-toolsmiths-service-user
  • aogata-inst
  • instout