Skip to content
mokly.

Type to search every page of the docs.

DocumentationGetting started

Getting started

Install Mokly, describe your catalogue and open your screens in the browser.

Install Mokly

Mokly runs from the repository that holds your components, as a development dependency. React and React DOM render your screens.

shell
npm install --save-dev @mokly/mokly react react-dom

Next, describe where your screens live, author one screen and open the catalogue in your browser. The five pages under Getting started take you through it in order.

What is here

  • Getting started — Install Mokly, point it at your screens and open the catalogue.
  • Authoring — Describe screens, components, flows and pages in TypeScript.
  • Catalogue — Browse, search, compare and export what the build produced.
  • Continuous integration — Publish a catalogue from a workflow on every branch.
  • CLI reference — Every command, the options it takes and what it writes.
  • Mokly Cloud — The hosted service: repositories, publications and access.
  • Reference — The contracts an integrator builds against, from the source.
  • Review and edit — Comments, approvals and the agent beside the screen.