Skip to content

Latest commit

 

History

History
32 lines (22 loc) · 979 Bytes

DEVELOPMENT.md

File metadata and controls

32 lines (22 loc) · 979 Bytes
Raw

Development

  1. install Node.js
  2. start coding 🚀

Create a local development setup

Install Node.js

To start contributing you need Node.js installed on your machine. For macOS users, we recommend doing that with nvm a node version manager. While Windows users should go with the LTS version of Node.js.

Documentation

Structure

  • packages:
    • docs: main web-site
    • mosaic:
      • button: button.md – button description
      • button-toggle: button-toggle.md – button-toggle description
    • mosaic-examples: examples that are displayed in the documentation

Adding new examples

  1. Create (or update) a Markdown file with the component description. This file is located in the component folder mosaic/<component>/<component>.md.

  2. Create (or update) files with the component code. This file is located in the mosaic-examples folder.