This repository has been archived by the owner on Mar 10, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
19 changed files
with
227 additions
and
153 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
41 changes: 23 additions & 18 deletions
41
apps/ngx-doc-gen-demo/src/app/components/home/home.component.html
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,48 +1,53 @@ | ||
<div class="mat-typography"> | ||
|
||
<h2> | ||
Welcome to ngx-doc-gen | ||
</h2> | ||
<h2>Welcome to ngx-doc-gen</h2> | ||
|
||
<p> | ||
This page is for showcasing the generated API docs for the example libraries contained in the repository. | ||
This page is for showcasing the generated API docs for the example libraries | ||
contained in the repository. | ||
</p> | ||
|
||
<p> | ||
Those libraries feature two possible aspects of common library layouts - single and multi entrypoint. All results | ||
are used here as component templates. | ||
Those libraries feature two possible aspects of common library layouts - | ||
single and multi entrypoint. All results are used here as component | ||
templates. | ||
</p> | ||
|
||
<a [routerLink]="['single-entrypoint']" class="content-link"> | ||
<h3> | ||
Single entrypoint | ||
<mat-icon> | ||
open_in_new | ||
</mat-icon> | ||
<mat-icon> open_in_new </mat-icon> | ||
</h3> | ||
</a> | ||
|
||
<p> | ||
Maybe the most common library layout out there - where there is one single entrypoint exporting your librarys API. | ||
Maybe the most common library layout out there - where there is one single | ||
entrypoint exporting your librarys API. | ||
</p> | ||
|
||
<a [routerLink]="['multi-entrypoint']" class="content-link"> | ||
<h3> | ||
Multi entrypoint | ||
<mat-icon> | ||
open_in_new | ||
</mat-icon> | ||
<mat-icon> open_in_new </mat-icon> | ||
</h3> | ||
</a> | ||
|
||
<p> | ||
Known from popular libraries like Angular Material - your library contains multiple entrypoints focussed on specific | ||
features. | ||
Known from popular libraries like Angular Material - your library contains | ||
multiple entrypoints focussed on specific features. | ||
</p> | ||
|
||
<p> | ||
Note: This showcase uses Angular Materials Expansion Panel to visually divide the entrypoints API docs - generation | ||
outputs one HTML file per entrypoint. | ||
Note: This showcase uses Angular Materials Expansion Panel to visually | ||
divide the entrypoints API docs - generation outputs one HTML file per | ||
entrypoint. | ||
</p> | ||
|
||
<a [routerLink]="['standalone-api']" class="content-link"> | ||
<h3> | ||
Standalone API | ||
<mat-icon> open_in_new </mat-icon> | ||
</h3> | ||
</a> | ||
|
||
<p>Showcasing the support for the Angular Standalone API.</p> | ||
</div> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
25 changes: 4 additions & 21 deletions
25
apps/ngx-doc-gen-demo/src/app/components/multi-two/multi-test-two.html
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,26 +1,9 @@ | ||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<div class="docs-api"> | ||
<h2> | ||
API reference for @multi/test/two | ||
</h2><p class="docs-api-module-import"> | ||
<h2>API reference for @multi/test/two</h2><p class="docs-api-module-import"> | ||
<code> | ||
import { TwoModule } from '@multi/test/two'; | ||
</code> | ||
import { TwoModule } from '@multi/test/two'; | ||
</code> | ||
</p> | ||
</div> |
44 changes: 13 additions & 31 deletions
44
apps/ngx-doc-gen-demo/src/app/components/single-entrypoint/single-test.html
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,49 +1,31 @@ | ||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<div class="docs-api"> | ||
<h2> | ||
API reference for @single/test | ||
</h2><p class="docs-api-module-import"> | ||
<h2>API reference for @single/test</h2><p class="docs-api-module-import"> | ||
<code> | ||
import { SingleEntrypointModule } from '@single/test'; | ||
</code> | ||
import { SingleEntrypointModule } from '@single/test'; | ||
</code> | ||
</p> | ||
<h3 id="single-test-directives" class="docs-header-link docs-api-h3"> | ||
<span header-link="directives"></span> | ||
Directives | ||
</h3> | ||
|
||
|
||
|
||
|
||
<h4 id="TestComponent" class="docs-header-link docs-api-h4 docs-api-class-name"> | ||
<h4 | ||
id="TestComponent" | ||
class="docs-header-link docs-api-h4 docs-api-class-name" | ||
> | ||
<span header-link="TestComponent"></span> | ||
<code>TestComponent</code> | ||
|
||
</h4><div class="docs-api-class-description"><p>Example component for showcasing API doc generation.</p> | ||
</h4><div class="docs-api-class-description"> | ||
<p>Example component for showcasing API doc generation.</p> | ||
|
||
</div><p class="docs-api-directive-selectors"> | ||
<span class="docs-api-class-selector-label">Selector:</span> | ||
|
||
<span class="docs-api-class-selector-name">ngx-doc-gen-test</span> | ||
|
||
</p> | ||
|
||
|
||
|
||
|
||
|
||
</p> | ||
</div> |
Empty file.
8 changes: 8 additions & 0 deletions
8
apps/ngx-doc-gen-demo/src/app/components/standalone-api/standalone-api.component.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
import { Component } from '@angular/core'; | ||
|
||
@Component({ | ||
selector: 'ngx-doc-gen-standalone-api', | ||
templateUrl: './standalone-api.html', | ||
styleUrls: ['./standalone-api.component.scss'], | ||
}) | ||
export class StandaloneApiComponent {} |
Oops, something went wrong.