0.1.1 • Published 4 years ago

@rock-kit/ui-docs-client v0.1.1

Weekly downloads
-
License
MIT
Repository
github
Last release
4 years ago

category: packages

ui-docs-client

npm  build-status  MIT License  Code of Conduct

A client application to display documentation made by Rock Content.

Installation

yarn add @rock-kit/ui-docs-client

Usage

import renderDocsClient from '@rock-kit/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 @rock-kit/ui-docs-plugin.

Development

From the root of the rock-kit repo:

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