@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

    Keywords

    none

    Install

    npm i @instructure/ui-docs-client

    DownloadsWeekly Downloads

    1,127

    Version

    8.1.0

    License

    MIT

    Unpacked Size

    861 kB

    Total Files

    198

    Last publish

    Collaborators

    • kyler-instructure
    • jonscheiding
    • instuici
    • codequistador
    • natearmstrong
    • eschiebel
    • maths22
    • hyan
    • jcrystal
    • skacsmark
    • itadmins
    • quizzesuici
    • instructure-toolsmiths-service-user
    • prenner
    • aogata-inst
    • acallejas
    • viktor.ohad
    • eszter.szabo
    • amireh-inst
    • daniel.hatas.instructure
    • brianlwatson
    • instout