Skip to content
This repository has been archived by the owner on Sep 28, 2023. It is now read-only.

Commit

Permalink
fix(documeentation):remove repetition, adding mising information
Browse files Browse the repository at this point in the history
  • Loading branch information
Mukuna Ciowela Lionel committed May 22, 2019
1 parent c9d284c commit 7bc0907
Showing 1 changed file with 6 additions and 8 deletions.
14 changes: 6 additions & 8 deletions docs/app/start.component.html
Original file line number Diff line number Diff line change
Expand Up @@ -16,39 +16,37 @@ <h3>Dependencies</h3>
<p>Here are the dependencies that we rely on and you don't need to explicitly add to your project:</p>
<ul class="o-square-list">
<li><a href="http://boosted.orange.com">Boosted {{globals.boostedVersion}}</a></li>
<li><a href="https://ng-bootstrap.github.io/">ng-bootstrap {{globals.ngBootstrapVersion}}</a></li>
<li><a href="https://ng-bootstrap.github.io/">Ng-bootstrap {{globals.ngBootstrapVersion}}</a></li>
</ul>
<p>Beware the versions above-mentioned are <b>the minimal required versions</b>.
Some components need ng-bootstrap import. Find below instructions.</p>
<h3>Installation</h3>
<p>For <code>ng-bootstrap</code> installation, please see the documentation <a href="https://ng-bootstrap.github.io/#/getting-started">here.</a></p>
<p>For <code>ng-bootstrap</code> installation, please see the documentation <a href="https://ng-bootstrap.github.io/#/getting-started#installation">here.</a></p>

<p>Install <code>ng-boosted</code> via:</p>

<p><code>npm install --save ng-boosted</code></p>
or <br>
<p><code>yarn add ng-boosted</code></p>

<p>Once installed, you need to import <code>ng-boosted</code> modules and <code>ng-bootstrap, if you use it</code>.</p>
<p>Once installed, you need to import <code>ng-boosted</code> modules.</p>

<p><code>
import {{ '{' }} NgbModule {{ '}' }} from '@ng-bootstrap/ng-bootstrap';<br>
import {{ '{' }} NgBoostedModule {{ '}' }} from 'ng-boosted';
</code></p>

<p><code>
@NgModule({{ '{' }}<br>
&emsp;declarations: [AppComponent, ...],<br>
&emsp;imports: [NgbModule.forRoot(), NgBoostedModule, ...],<br>
&emsp;imports: [ NgBoostedModule, ...],<br>
&emsp;bootstrap: [AppComponent]<br>
{{ '}' }})<br>
export class AppModule {{ '{' }}<br>
{{ '}' }}<br>
</code></p>

<p>
If you need to use a component from ng-bootstrap you need to import it like explained in the ng-bootstrap documentation <a href="https://ng-bootstrap.github.io/#/getting-started">here</a>.
<code>import {{ '{' }} NgbModule, NgbActiveModal {{ '}' }} from '@ng-bootstrap/ng-bootstrap'; </code>
If you need to use a component from ng-bootstrap you need to import it like explained in the ng-bootstrap documentation <a href="https://ng-bootstrap.github.io/#/getting-started#installation">here</a>.
</p>

<h2>Adding Boosted CSS</h2>
Expand All @@ -72,7 +70,7 @@ <h3>Configure your styles.scss with SASS</h3>
<h2>Building this documentation</h2>
<p>Simply <code>npm run build:docs</code> and the output goes to a <code>_gh_pages</code> folder.</p>

<p>You can also run this documentation with <code>npm start</code></p>
<p>You can also run this documentation with <code>npm run start</code></p>

<p>The output is then served to <a href="http://localhost:3030">http://localhost:3030</a>
</p>
Expand Down

0 comments on commit 7bc0907

Please sign in to comment.