Skip to content
This repository was archived by the owner on Feb 2, 2025. It is now read-only.

Commit b4ba3b5

Browse files
committed
doc: remove useless FAQ + fix online documentation
1 parent 2f5cecf commit b4ba3b5

File tree

3 files changed

+13
-53
lines changed

3 files changed

+13
-53
lines changed

README.md

Lines changed: 3 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -2,41 +2,14 @@
22

33
> [Angular](https://angular.io/) + [DataTables](https://datatables.net/)
44
5-
# Usage
6-
7-
Step 1:
8-
```
9-
ng add angular-datatables
10-
```
11-
Step 2:
12-
13-
Import `DataTablesModule` to your required module in your project.
14-
155
# Documentation
166

177
Please check the [online documentation](http://l-lin.github.io/angular-datatables/)
188

19-
# FAQ
20-
## Why version 4.X? Where is version 3.X? And 1.X?
21-
22-
The major version of the project (it's using a [Semantic versioning](http://semver.org/)) will be synchronized with the major version of Angular.
23-
24-
## Why is there less functionality?
25-
26-
Because, I'm still working on it... But, if you want to contribute, feel free to make a pull request!
27-
28-
## Will you still work on version 0.X.Y?
29-
30-
Nope, not anymore!
31-
32-
## Why no BowerJS? GruntJS?
33-
34-
Let's not multiply the tools and do all in NPM!
35-
36-
## Where are the DTOptionsBuilder, DTColumnBuilder and DTColumnDefBuilder?
9+
# Versioning
3710

38-
In the first versions of angular-datatables, there is a builder to help with using the directive.
39-
However, they seem to have brought more confusion instead. So, starting from version 2, you will need to provide the options directly, like in the DataTable's documentation.
11+
The major version of the project (it's using a [Semantic versioning](http://semver.org/)) is
12+
synchronized with the major version of Angular.
4013

4114
# Getting involved
4215

demo/src/app/getting-started.component.html

Lines changed: 8 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -16,35 +16,28 @@ <h2 class="header">Installation</h2>
1616
To use angular-datatables, you need to have <a href="https://docs.npmjs.com/getting-started/installing-node">Node {{ nodeVersion }} or higher and NPM {{ npmVersion }} or higher installed</a>.
1717
</p>
1818
<p class="caption">
19-
The documentation will only deal with projects that use <a href="https://github.com/angular/angular-cli">angular-cli</a>. Indeed, the front-end ecosystem is evolving at a pace I can't follow anymore. Thus, there will only have a tutorial for angular-cli's project. If you managed to make it work in, for example, SystemJS projects, please submit a pull request to improve this documentation. Thanks!
19+
The documentation will only deal with projects that use <a href="https://cli.angular.io/">angular-cli</a>. Indeed, the front-end ecosystem is evolving at a pace I can't follow anymore. Thus, there will only have a tutorial for angular-cli's project. If you managed to make it work in, for example, SystemJS projects, please submit a pull request to improve this documentation. Thanks!
2020
</p>
2121
<div class="col s12">
22-
<h4>Angular-CLI version {{ angularCliVersion }}</h4>
23-
<p>I recommend using <a href="https://github.com/angular/angular-cli">angular-cli</a> to create and manage your angular project</p>
24-
<p>
25-
I prefer to warn you the demo was developpped in version <b>{{ angularCliVersion }}</b> and older and newer versions of Angular-CLI may need to have different configuration.
26-
</p>
27-
</div>
28-
<div class="col s12">
29-
<h4>NPM</h4>
30-
<p>You need to install its dependencies before getting the latest release using NPM:</p>
31-
<section [innerHTML]="npmInstallSnippet" highlight-js-content=".bash"></section>
22+
<h4>Angular-CLI</h4>
23+
<p>Using <a href="https://github.com/angular/angular-cli">angular-cli</a>, add the angular-datatables dependency:</p>
24+
<section [innerHTML]="ngAddSnippet" hljsContent=".bash"></section>
3225
</div>
3326
</div>
3427

3528
<div class="section">
3629
<h2 class="header" id="setup">Setup</h2>
3730
<div class="col s12">
3831
<h4 id="angular-cli">angular.json</h4>
39-
<p>Add the dependencies in the scripts and styles attributes:</p>
40-
<section [innerHTML]="angularJsonSnippet" highlight-js-content=".json"></section>
32+
<p>Add the dependencies in the scripts and styles attributes (if not already done by <code>ng add</code>):</p>
33+
<section [innerHTML]="angularJsonSnippet" hljsContent=".json"></section>
4134
</div>
4235
<div class="col s12">
4336
<h4 id="ng-module">NgModule</h4>
4437
<p>
4538
Import the <code>DataTablesModule</code> at the appropriate level of your app.
4639
</p>
47-
<section [innerHTML]="ngModuleSnippet" highlight-js-content=".typescript"></section>
40+
<section [innerHTML]="ngModuleSnippet" hljsContent=".typescript"></section>
4841
</div>
4942
</div>
5043

@@ -61,7 +54,7 @@ <h4 id="error-resolving-symbol">Error encountered resolving symbol values static
6154
<p>
6255
Please update your <code>tsconfig.json</code> and add the following blocks:
6356
</p>
64-
<section [innerHTML]="errorResolvingSymbolSnippet" highlight-js-content=".json"></section>
57+
<section [innerHTML]="errorResolvingSymbolSnippet" hljsContent=".json"></section>
6558
<p>
6659
More information <a href="https://github.com/l-lin/angular-datatables/issues/937">HERE</a>.
6760
</p>

demo/src/app/getting-started.component.ts

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,9 @@ import { Component } from '@angular/core';
77
export class GettingStartedComponent {
88
nodeVersion = '10';
99
npmVersion = '6';
10-
angularCliVersion = '8.Y.Z';
11-
npmInstallSnippet = `
10+
ngAddSnippet = `
1211
<pre>
13-
<code class="bash highlight">npm install jquery --save
14-
npm install datatables.net --save
15-
npm install datatables.net-dt --save
16-
npm install angular-datatables --save
17-
npm install @types/jquery --save-dev
18-
npm install @types/datatables.net --save-dev</code>
12+
<code class="bash highlight">ng add angular-datatables</code>
1913
</pre>`;
2014

2115
angularJsonSnippet = `

0 commit comments

Comments
 (0)