Documentation

Our documentation site lives at below.hyphev.com.

Installation

Install @hyphev/below in your project with npm:

npm install @hyphev/below

Usage

The included source files are written in [Sass] using SCSS syntax. After installing with npm, you can add your project's node_modules directory to your Sass include paths (AKA load paths in Ruby), then import it like this:

@import "@hyphev/below/";

You can import individual below modules directly from the @hyphev/below package:

@import "@hyphev/below/globals/";
@import "@hyphev/below/foldings/";
@import "@hyphev/below/menus/";

Local Development

To run @hyphev/below locally when adding or updating components:

1. Clone this repo: git clone https://github.com/hyphev/below
2. Install dependencies: npm install
3. Compile dist: npm run dist
4. Run the dev app: npm start

[WIP] See the contributing docs for more info on code style, testing, and coverage.