Nomenclature Processing Machine

    This package has been deprecated

    Author message:

    This library is deprecated.

    @readme/ui

    1.17.8 • Public • Published

    ReadMe UI

    Owlblocks! UI component library and design system for ReadMe's front end.

    npm install -S @readme/ui

    Workflow

    Run these commands to develop and document UI components locally:

    npm start     # start the local Styleguidist dev server
    npm test      # run tests against the UI library
    npm run watch # watch and rebuild, for local linked dev

    Creating New Components

    Use the elem command to quickly scaffold out a new component or composition:

    npm run elem -- MyUIElement "composition" # or "component" by default

    This generates the JSX file, stylesheet, tests, and markdown docs for your new element all in one go.

    Architecture

    src/
    │ ui/             # UI component library:
    │ ├ components/   # - lower-level UI building blocks
    │ └ compositions/ # - higher-order UI constructs
    └ styles/         # SCSS vars, mixins; CSS resets; etc.

    Under the Hood

    This repository brings together a number of utilities and tools for various front end development workflows:

    Dependencies  
    React & Sass for components and styling
    Styleguidist to power our living documentation
    Babel & Webpack/NWB for transpiling and compilation
    Lodash for various Javascript utility methods

    Install

    npm i @readme/ui

    DownloadsWeekly Downloads

    103

    Version

    1.17.8

    License

    ISC

    Unpacked Size

    8.08 MB

    Total Files

    419

    Last publish

    Collaborators

    • dannobytes
    • gkoberger
    • domharrington
    • mjcuva
    • kanadgupta
    • jonursenbach
    • rafegoldberg
    • dashron
    • iliast