Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(documentation): fix issues after redesign #2761

Merged
merged 4 commits into from
Sep 29, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ <h1 align="center">
</h1>

<p align="center">
The best way to quickly integrate <a href="https://getbootstrap.com/">Bootstrap 3</a> or <a
The best way to quickly integrate <a href="https://getbootstrap.com/docs/3.3/">Bootstrap 3</a> or <a
href="https://getbootstrap.com/docs/4.0">Bootstrap 4</a> Components with <a href="https://angular.io/">Angular</a>
</p>

Expand Down
18 changes: 9 additions & 9 deletions demo/src/app/common/getting-started/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,11 @@
6. [Contributing](#contribution)
7. [License](#license)

# Getting Started
## Getting Started

ngx-bootstrap contains all core (and not only) Bootstrap components powered by Angular. So you don't need to include original JS components, but we are using markup and css provided by Bootstrap.

# Installation instructions
## Installation instructions

Install `ngx-bootstrap` from `npm`
```bash
Expand Down Expand Up @@ -45,37 +45,37 @@ To enable bootstrap 4 theme templates in ngx-bootstrap, please read
```


## How to use it with:
### How to use it with:
- `angular-cli` please refer to [getting-started-with-ng-cli](https://github.com/valor-software/ngx-bootstrap/tree/development/docs/getting-started/ng-cli.md)
- `angular-seed` please refer to [getting-started-with-angular-seed](https://github.com/valor-software/ngx-bootstrap/tree/development/docs/getting-started/angular-seed.md)
- `system.js` (and [angular quickstart](https://angular.io/docs/ts/latest/quickstart.html)) please checkout [sample repository](https://github.com/valor-software/angular2-quickstart)
- `plnkr` sample available [here](http://bit.ly/ng2-bootstrap-plnkr)
- `AoT using ngc and rollup` please refer to [ngx-bootstrap-with-aot](https://github.com/valor-software/ngx-bootstrap/tree/development/docs/getting-started/aot.md)
- `Bootstrap 4 and angular-cli` please refer to [using-with-bootstrap-4-and-angular-cli](https://github.com/valor-software/ngx-bootstrap/tree/development/docs/getting-started/bootstrap4.md)

# Usage & Demo
## Usage & Demo

Main source of API documentation and usage scenarious available here:
[http://valor-software.github.io/ngx-bootstrap/](http://valor-software.github.io/ngx-bootstrap/)

# API
## API
Check demo page for API [reference](http://valor-software.github.io/ngx-bootstrap/)

# Troubleshooting
## Troubleshooting

So you are in trouble, where to get help:
- you can search and ask for help at [StackOverflow](https://stackoverflow.com/questions/tagged/ngx-bootstrap)
- you can join [slack](https://ngx-slack.herokuapp.com/) and ask a question
- if none of this helped please [search](https://github.com/valor-software/ngx-bootstrap/issues?utf8=%E2%9C%93&q=is%3Aissue) and only then open new issue

# Contribution
## Contribution

Are very welcome! And remember, contribution is not only PRs and code, but any help with docs or helping other developers to solve issues are very appreciated! Thanks in advance!

## If you need more modules check [here](https://github.com/valor-software/ng2-plans)
### If you need more modules check [here](https://github.com/valor-software/ng2-plans)

Please read central `ngx` modules [readme](https://github.com/valor-software/ng2-plans) for details, plans and approach

## Credits
### Credits
Crossbrowser testing sponsored by [Browser Stack](https://www.browserstack.com)
[<img src="https://camo.githubusercontent.com/a7b268f2785656ab3ca7b1cbb1633ee5affceb8f/68747470733a2f2f64677a6f7139623561736a67312e636c6f756466726f6e742e6e65742f70726f64756374696f6e2f696d616765732f6c61796f75742f6c6f676f2d6865616465722e706e67" alt="Browser Stack" height="31px" style="background: cornflowerblue;">](https://www.browserstack.com)
2 changes: 1 addition & 1 deletion demo/src/app/common/landing/landing.component.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ <h1 class="slogan">Develop better. Faster.</h1>
<p class="descr">Bootstrap components, powered by Angular</p>
<div class="btn-block">
<a class="btn btn-primary" href="#/getting-started">Get started</a>
<a class="btn btn-outline-secondary" href="#/https://github.com/valor-software/ngx-bootstrap">Github</a>
<a class="btn btn-outline-secondary" href="https://github.com/valor-software/ngx-bootstrap">Github</a>
</div>
<p class="version">{{currentVersion}}</p>
</section>
Expand Down
5 changes: 5 additions & 0 deletions demo/src/app/common/top-menu/top-menu.component.html
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,11 @@ <h1 class="logo" [routerLink]="['']">
</div>

<ul class="header-list">
<li>
<a target="_blank" rel="noopener" href="https://stackoverflow.com/questions/tagged/ngx-bootstrap">
<img src="assets/images/icons/stackoverflow.svg" alt="slack">
</a>
</li>
<li>
<a target="_blank" rel="noopener" href="https://github.com/valor-software/ngx-bootstrap">
<img src="assets/images/icons/icon-git.svg" alt="github stars">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<section class="main-container">
<div class="content">
<div class="content-header">
<h1>{{name}}
<h1 *ngIf="name || src">{{name}}
<a [href]="src" target="_blank" rel="noopener">
<img src="assets/images/link-doc.png" alt="link to doc"/>
</a>
Expand Down
Empty file removed demo/src/assets/css/style.css
Empty file.
4 changes: 4 additions & 0 deletions demo/src/assets/css/style.scss
Original file line number Diff line number Diff line change
Expand Up @@ -466,6 +466,10 @@ a:hover {
.logo {
font-size: 1.25rem;
}

.prev-docs {
display: none;
}
}
.advantages {
.holder {
Expand Down
1 change: 1 addition & 0 deletions demo/src/assets/images/icons/stackoverflow.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.