Skip to content

Commit

Permalink
Merge pull request #46 from alireza-sohrabi/ISSUE-45-improve-documents
Browse files Browse the repository at this point in the history
ISSUE-45, feat(documents): rewrite documents with ng docs
  • Loading branch information
alireza-sohrabi committed Jul 24, 2023
2 parents c75ec0d + a1ec80c commit 36a9c8b
Show file tree
Hide file tree
Showing 99 changed files with 8,237 additions and 3,523 deletions.
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -46,3 +46,7 @@ testem.log
Thumbs.db

.angular


# NgDoc files
.ng-doc
43 changes: 8 additions & 35 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,51 +8,24 @@ Extra Advantages that you'll gain more than using mat-select:
* `Searchable` in the both client and server side modes
* `Virtual Scroll` in the both client and server side modes as well
* `Infinite Scroll` in the server side mode
* `spacial panel views` such as Bottom-Sheet and Full-Screen modes

RLT support (use dir='rtl' in html tag)

<a target="_blank" href="https://alireza-sohrabi.github.io/ngx-mat-select">See demo and
samples `Online`
<a target="_blank" href="https://alireza-sohrabi.github.io/ngx-mat-select">Documents `Online`
</a>

<a target="_blank" href="https://stackblitz.com/edit/ngx-mat-select?file=src/app/app.component.html">See demo and
samples on
<a target="_blank" href="https://stackblitz.com/edit/ngx-mat-select?file=src/app/app.component.html">Source Code
`Stackblitz`</a>

<a target="_blank" href="https://ngx-mat-select.gitbook.io/ngx-mat-select">See documents on
`gitbook`
</a>

# Version compatibility

<table>
<thead>
<tr>
<td>
Angular Material
</td>
<td>
NgxMatSelect
</td>
</tr>
</thead>
<tbody>
<tr>
<td>16.x.x</td>
<td> >=16</td>
</tr>
<tr>
<td>15.x.x</td>
<td> >= 15 </td>
</tr>
<tr>
<td>14.x.x</td>
<td> >= 14 </td>
</tr>

</tbody>
</table>
| Angular Material | NgxMatSelect |
|------------------|---------------|
| 16.x.x | >= 16 |
| 15.x.x | >= 15 |
| 14.x.x | >= 14 |


# Installation Guide

Expand Down
25 changes: 22 additions & 3 deletions angular.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,26 +11,45 @@
"prefix": "app",
"architect": {
"build": {
"builder": "@angular-devkit/build-angular:browser",
"builder": "@ng-doc/builder:browser",
"options": {
"outputPath": "dist/ngx-mat-select",
"index": "src/index.html",
"main": "src/main.ts",
"polyfills": "src/polyfills.ts",
"tsConfig": "tsconfig.app.json",
"assets": [
{
"glob": "**/*",
"input": "node_modules/@ng-doc/app/assets",
"output": "assets/ng-doc/app"
},
{
"glob": "**/*",
"input": "node_modules/@ng-doc/ui-kit/assets",
"output": "assets/ng-doc/ui-kit"
},
{
"glob": "**/*",
"input": ".ng-doc/ngx-mat-select/assets",
"output": "assets/ng-doc"
},
"src/favicon.ico",
"src/assets"
],
"styles": [
"node_modules/@ng-doc/app/styles/global.css",
"src/styles.scss"
],
"stylePreprocessorOptions": {
"includePaths": [
"node_modules/@angular/material"
]
},
"scripts": []
"scripts": [],
"allowedCommonJsDependencies": [
"@ng-doc/core"
]
},
"configurations": {
"production": {
Expand Down Expand Up @@ -63,7 +82,7 @@
}
},
"serve": {
"builder": "@angular-devkit/build-angular:dev-server",
"builder": "@ng-doc/builder:dev-server",
"options": {
"browserTarget": "ngx-mat-select:build"
},
Expand Down

0 comments on commit 36a9c8b

Please sign in to comment.