Getting Started

The getting started page should provide information for how to get up and running with the design system.

hTWOo can be used in two ways.

  • npm install
  • via CDN

NPM Install

First install the package.

npm install --save-dev @n8d/htwoo-core

Once installed you can import the SASS files from your node_modules folder.

How to use

CDN Support

To use hTWOo from CDN use the following URLs. The CDN version only offer limited capabilities but contain all styling.

For CSS

<link rel="stylesheet" href="https://unpkg.com/browse/@n8d/htwoo-core@<version>/dist/css/htwoo.min.css">

For JavaScript

<script src="https://unpkg.com/browse/@n8d/htwoo-core@<version>/dist/js/"></script>

Check out the package on unpkg.

File Structure of npm package

htwoo-core/
.
├── LICENSE
├── README.md
├── dist                  <- For use From CDN
│   ├── css
│   │   └── htwoo.min.css <- Pre-compiled css
│   └── js                <- Additional JavaScripts
│       ├── amd
│       ├── cjs
│       └── umd
│
├── lib
│   ├── components
│   │   ├── _all.scss
│   │   ├── _avatar.scss
│   │   ├── _base.scss
│   │   ├── _button.scss
│   │   ├── _cards.scss
│   │   ├── _dialogs.scss
│   │   ├── _forms.scss
│   │   ├── _icon.scss
│   │   ├── _loading.scss
│   │   ├── _menus.scss
│   │   ├── _table.scss
│   │   ├── _typography.scss
│   │   ├── _webpart-title.scss
│   │   └── _webparts.scss
│   ├── js               <- Pure JavaScripts
│   └── sass             <- Contains the implementation of hTWOOo