From 4e09bdb2c28bbb68fc3f04fbf1c94689dea6b364 Mon Sep 17 00:00:00 2001 From: Lionel Mukuna Ciowela Date: Wed, 24 Apr 2019 13:44:10 +0200 Subject: [PATCH] fix(documentation): updates documentation --- docs/app/start.component.html | 19 +++++++++++++------ 1 file changed, 13 insertions(+), 6 deletions(-) diff --git a/docs/app/start.component.html b/docs/app/start.component.html index 7bdd6d12..3a1e0802 100644 --- a/docs/app/start.component.html +++ b/docs/app/start.component.html @@ -11,13 +11,13 @@

Getting started

Dependencies

Ng-boosted is a set of custom components and directives that allows you to run your Angular based projet with Boosted CSS.

-

Before your start using Ng-boosted you need the following dependencies :

+

Before you start using Ng-Boosted you need the following dependencies :

- +

Beware of the version above-mentioned are the minimal required versions.

Installation

For ng-bootstrap installation please see the documentation here

@@ -25,7 +25,7 @@

Installation

npm install --save ng-boosted

-

Once installed you need to import ng-bootstrap and ng-boosted modules.

+

Once installed, you need to import ng-bootstrap and ng-boosted modules.

import {{ '{' }} NgbModule {{ '}' }} from '@ng-bootstrap/ng-bootstrap';
@@ -43,15 +43,22 @@

Installation

Adding Boosted CSS

-

Two options can be done to import Boosted installed from NPM

-

- Configuer your angular.json as:
+

Two options can be done to import Boosted installed from npm

+

Configure your angular.json

+

Inside the file, add the following path:
"styles": [
"/path/node_modules/boosted/dist/css/boosted.min.css",
"styles.css"
]

- - Or import directly in src/style.css or src/style.scss:
+

+

Configure your styles.css

+

Inside your styles.css, import boosted css: @import '~boosted/dist/css/boosted.min.css'

+

Configure your styles.scss

+

if you are using SASS, then you need to do this in your styles.scss: + @import '../node_modules/boosted/scss/boosted.scss' +

Building this documentation

Simply npm run build:docs and the output goes to a _gh_pages folder.