@ng-doc/builder 15.9.0 → 15.10.0-beta.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +0 -2
- package/engine/.cache/apps/ng-doc/src/app/docs/content/api/ng-doc.category.js +42 -0
- package/engine/.cache/apps/ng-doc/src/app/docs/content/{api-templating → api/templating}/ng-doc.page.js +14 -5
- package/engine/.cache/apps/ng-doc/src/app/docs/content/guides/demo-pane/ng-doc.page.js +51 -0
- package/engine/.cache/apps/ng-doc/src/app/docs/content/guides/snippets/ng-doc.page.js +51 -0
- package/engine/.cache/apps/ng-doc/src/app/docs/{getting-started/roadmap → customization/search}/ng-doc.page.js +13 -13
- package/engine/.cache/apps/ng-doc/src/app/docs/customization/themes/ng-doc.page.js +1 -1
- package/engine/.cache/apps/ng-doc/src/app/docs/customization/type-controls/ng-doc.page.js +1 -1
- package/engine/.cache/apps/ng-doc/src/app/docs/develop/ng-doc.page.js +0 -4247
- package/engine/.cache/apps/ng-doc/src/app/docs/{entities → file-entities}/api/ng-doc.page.js +4 -4
- package/engine/.cache/apps/ng-doc/src/app/docs/{entities → file-entities}/category/ng-doc.page.js +4 -4
- package/engine/.cache/apps/ng-doc/src/app/docs/{entities → file-entities}/dependencies/ng-doc.page.js +4 -4
- package/engine/.cache/apps/ng-doc/src/app/docs/{entities → file-entities}/ng-doc.category.js +2 -2
- package/engine/.cache/apps/ng-doc/src/app/docs/{entities → file-entities}/page/ng-doc.page.js +4 -4
- package/engine/.cache/apps/ng-doc/src/app/docs/ng-doc.api.js +1 -1
- package/engine/actions/demo-pane.action.d.ts +10 -0
- package/engine/actions/demo-pane.action.js +22 -0
- package/engine/actions/demo-pane.action.js.map +1 -0
- package/engine/actions/demo.action.d.ts +3 -3
- package/engine/actions/demo.action.js +4 -4
- package/engine/actions/playground.action.js +1 -1
- package/engine/actions/playground.action.js.map +1 -1
- package/engine/actions.d.ts +2 -1
- package/engine/actions.js +4 -0
- package/engine/actions.js.map +1 -1
- package/engine/entities/abstractions/entity.d.ts +3 -0
- package/engine/entities/abstractions/entity.js +30 -8
- package/engine/entities/abstractions/entity.js.map +1 -1
- package/engine/entities/abstractions/route.entity.js +0 -5
- package/engine/entities/abstractions/route.entity.js.map +1 -1
- package/engine/entities/page.entity.d.ts +1 -0
- package/engine/entities/page.entity.js +4 -1
- package/engine/entities/page.entity.js.map +1 -1
- package/engine/entities/skeleton.entity.js +7 -9
- package/engine/entities/skeleton.entity.js.map +1 -1
- package/engine/entity-store.d.ts +1 -1
- package/engine/entity-store.js.map +1 -1
- package/engine/extentions/index.extension.d.ts +6 -0
- package/engine/extentions/index.extension.js +25 -0
- package/engine/extentions/index.extension.js.map +1 -0
- package/engine/index.d.ts +0 -1
- package/engine/index.js +0 -1
- package/engine/index.js.map +1 -1
- package/engine/renderer.js +2 -0
- package/engine/renderer.js.map +1 -1
- package/engine/template-filters.d.ts +1 -1
- package/engine/template-filters.js +2 -1
- package/engine/template-filters.js.map +1 -1
- package/helpers/build-indexes.d.ts +9 -0
- package/helpers/build-indexes.js +117 -0
- package/helpers/build-indexes.js.map +1 -0
- package/helpers/extract-docs.js +14 -8
- package/helpers/extract-docs.js.map +1 -1
- package/helpers/extract-selectors.js.map +1 -1
- package/helpers/generate-api-entities.js.map +1 -1
- package/helpers/get-demo-class-declarations.js +1 -2
- package/helpers/get-demo-class-declarations.js.map +1 -1
- package/helpers/get-keyword-type-from-entity.d.ts +1 -1
- package/helpers/get-keyword-type-from-entity.js.map +1 -1
- package/helpers/get-playground-by-id.js.map +1 -1
- package/helpers/get-playground-properties.js +2 -1
- package/helpers/get-playground-properties.js.map +1 -1
- package/helpers/import-es-module.d.ts +6 -0
- package/helpers/import-es-module.js +13 -0
- package/helpers/import-es-module.js.map +1 -0
- package/helpers/index.d.ts +1 -1
- package/helpers/index.js +1 -1
- package/helpers/index.js.map +1 -1
- package/helpers/marked.d.ts +4 -1
- package/helpers/marked.js +45 -3
- package/helpers/marked.js.map +1 -1
- package/helpers/presentation.js +10 -5
- package/helpers/presentation.js.map +1 -1
- package/helpers/typescript/display-type.d.ts +6 -1
- package/helpers/typescript/display-type.js +10 -2
- package/helpers/typescript/display-type.js.map +1 -1
- package/helpers/typescript/member/member-type.d.ts +3 -3
- package/interfaces/configuration.d.ts +1 -1
- package/interfaces/index.d.ts +0 -1
- package/interfaces/index.js +0 -1
- package/interfaces/index.js.map +1 -1
- package/package.json +6 -13
- package/schematics/api/schema.d.ts +1 -1
- package/templates/api/base.html.nunj +8 -2
- package/templates/api/class.html.nunj +1 -1
- package/templates/api/interface.html.nunj +1 -1
- package/templates/api-page.module.ts.nunj +1 -0
- package/templates/api-scope.module.ts.nunj +1 -0
- package/templates/category.module.ts.nunj +1 -0
- package/templates/helpers/accessor.html.nunj +3 -3
- package/templates/helpers/badge.html.nunj +1 -1
- package/templates/helpers/constructor.html.nunj +2 -2
- package/templates/helpers/declaration-modifiers.html.nunj +3 -3
- package/templates/helpers/decorators.html.nunj +1 -1
- package/templates/helpers/members.html.nunj +3 -3
- package/templates/helpers/method.html.nunj +4 -4
- package/templates/helpers/modifier.html.nunj +1 -1
- package/templates/helpers/no-content.html.nunj +1 -1
- package/templates/helpers/parameters.html.nunj +3 -3
- package/templates/helpers/properties.html.nunj +3 -3
- package/templates/helpers/tag.html.nunj +1 -1
- package/templates/helpers/type.html.nunj +5 -1
- package/templates/page.module.ts.nunj +1 -0
- package/templates/parts/page-tags.html.nunj +3 -3
- package/templates/parts/see-also.html.nunj +1 -1
- package/types/action.d.ts +1 -1
- package/types/artifact-processor.d.ts +1 -1
- package/types/component-asset.d.ts +1 -1
- package/types/index.d.ts +0 -1
- package/types/index.js +0 -1
- package/types/index.js.map +1 -1
- package/types/snippet-type.d.ts +1 -1
- package/types/supported-declarations.d.ts +1 -1
- package/engine/post-processors/html-plugins/autolink-headings.d.ts +0 -6
- package/engine/post-processors/html-plugins/autolink-headings.js +0 -40
- package/engine/post-processors/html-plugins/autolink-headings.js.map +0 -1
- package/engine/post-processors/html-plugins/autolink-headings.ts +0 -40
- package/engine/post-processors/html-plugins/keywords-processor.d.ts +0 -8
- package/engine/post-processors/html-plugins/keywords-processor.js +0 -108
- package/engine/post-processors/html-plugins/keywords-processor.js.map +0 -1
- package/engine/post-processors/html-plugins/keywords-processor.ts +0 -125
- package/engine/post-processors/html-plugins/mark-elements.d.ts +0 -6
- package/engine/post-processors/html-plugins/mark-elements.js +0 -19
- package/engine/post-processors/html-plugins/mark-elements.js.map +0 -1
- package/engine/post-processors/html-plugins/mark-elements.ts +0 -17
- package/engine/post-processors/html-plugins/slugger.d.ts +0 -7
- package/engine/post-processors/html-plugins/slugger.js +0 -25
- package/engine/post-processors/html-plugins/slugger.js.map +0 -1
- package/engine/post-processors/html-plugins/slugger.ts +0 -26
- package/engine/post-processors/html-post-processor.d.ts +0 -9
- package/engine/post-processors/html-post-processor.js +0 -33
- package/engine/post-processors/html-post-processor.js.map +0 -1
- package/engine/post-processors/index.d.ts +0 -1
- package/engine/post-processors/index.js +0 -5
- package/engine/post-processors/index.js.map +0 -1
- package/helpers/build-global-indexes.d.ts +0 -6
- package/helpers/build-global-indexes.js +0 -141
- package/helpers/build-global-indexes.js.map +0 -1
- package/helpers/print-console.d.ts +0 -5
- package/helpers/print-console.js +0 -14
- package/helpers/print-console.js.map +0 -1
- package/interfaces/keyword-map.d.ts +0 -12
- package/interfaces/keyword-map.js +0 -3
- package/interfaces/keyword-map.js.map +0 -1
- package/types/keyword-type.d.ts +0 -2
- package/types/keyword-type.js +0 -3
- package/types/keyword-type.js.map +0 -1
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"display-type.js","sourceRoot":"","sources":["../../../../../libs/builder/helpers/typescript/display-type.ts"],"names":[],"mappings":";;;AAAA,
|
|
1
|
+
{"version":3,"file":"display-type.js","sourceRoot":"","sources":["../../../../../libs/builder/helpers/typescript/display-type.ts"],"names":[],"mappings":";;;AAAA,uCAAyD;AAEzD;;;GAGG;AACH,SAAgB,WAAW,CAAC,IAAU;IACrC,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,0BAAe,CAAC,YAAY,CAAC,CAAC;AAC9D,CAAC;AAFD,kCAEC;AAED;;;GAGG;AACH,SAAgB,eAAe,CAAC,IAAc;IAC7C,OAAO,IAAI,CAAC,OAAO,EAAE,CAAC;AACvB,CAAC;AAFD,0CAEC"}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
1
|
import { CallSignatureDeclaration, ClassInstanceMemberTypes, ConstructSignatureDeclaration, IndexSignatureDeclaration, TypeElementTypes } from 'ts-morph';
|
|
2
|
-
export
|
|
3
|
-
export
|
|
4
|
-
export
|
|
2
|
+
export type NgDocClassMember = ClassInstanceMemberTypes;
|
|
3
|
+
export type NgDocInterfaceMember = Exclude<TypeElementTypes, ConstructSignatureDeclaration | CallSignatureDeclaration | IndexSignatureDeclaration>;
|
|
4
|
+
export type NgDocMemberType = NgDocClassMember | NgDocInterfaceMember;
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { NgDocHeading } from '@ng-doc/core';
|
|
2
|
-
import { NgDocGlobalKeyword } from '
|
|
2
|
+
import { NgDocGlobalKeyword } from '@ng-doc/core/interfaces/keyword-map';
|
|
3
3
|
import { NgDocRepoConfig } from './repo-config';
|
|
4
4
|
/**
|
|
5
5
|
* NgDoc configuration interface, that configure NgDoc library
|
package/interfaces/index.d.ts
CHANGED
package/interfaces/index.js
CHANGED
|
@@ -6,7 +6,6 @@ tslib_1.__exportStar(require("./asset"), exports);
|
|
|
6
6
|
tslib_1.__exportStar(require("./builder-context"), exports);
|
|
7
7
|
tslib_1.__exportStar(require("./built-output"), exports);
|
|
8
8
|
tslib_1.__exportStar(require("./configuration"), exports);
|
|
9
|
-
tslib_1.__exportStar(require("./keyword-map"), exports);
|
|
10
9
|
tslib_1.__exportStar(require("./page-index"), exports);
|
|
11
10
|
tslib_1.__exportStar(require("./path-anchor"), exports);
|
|
12
11
|
tslib_1.__exportStar(require("./renderer-options"), exports);
|
package/interfaces/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../libs/builder/interfaces/index.ts"],"names":[],"mappings":";;;AAAA,0DAAgC;AAChC,kDAAwB;AACxB,4DAAkC;AAClC,yDAA+B;AAC/B,0DAAgC;AAChC,
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../libs/builder/interfaces/index.ts"],"names":[],"mappings":";;;AAAA,0DAAgC;AAChC,kDAAwB;AACxB,4DAAkC;AAClC,yDAA+B;AAC/B,0DAAgC;AAChC,uDAA6B;AAC7B,wDAA8B;AAC9B,6DAAmC;AACnC,wDAA8B;AAC9B,mDAAyB"}
|
package/package.json
CHANGED
|
@@ -1,31 +1,24 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@ng-doc/builder",
|
|
3
|
-
"version": "15.
|
|
3
|
+
"version": "15.10.0-beta.1",
|
|
4
4
|
"type": "commonjs",
|
|
5
5
|
"builders": "./builders.json",
|
|
6
6
|
"schematics": "./schematics/collection.json",
|
|
7
7
|
"dependencies": {
|
|
8
|
-
"@ng-doc/core": "15.
|
|
8
|
+
"@ng-doc/core": "15.10.0-beta.1",
|
|
9
|
+
"@ng-doc/utils": "15.10.0-beta.1",
|
|
9
10
|
"@angular-devkit/architect": ">=0.1500.0",
|
|
10
11
|
"chokidar": "^3.5.3",
|
|
11
12
|
"minimatch": "^5.1.0",
|
|
12
13
|
"rxjs": "^6.6.7",
|
|
13
14
|
"ts-morph": "^15.0.0",
|
|
14
15
|
"nunjucks": "^3.2.3",
|
|
15
|
-
"
|
|
16
|
+
"@orama/orama": "^1.0.0-beta.7",
|
|
17
|
+
"@orama/plugin-parsedoc": "^1.0.0-beta.7",
|
|
16
18
|
"posthtml-parser": "^0.11.0",
|
|
17
19
|
"prettier": "^2.6.2",
|
|
18
20
|
"glob": "^8.0.3",
|
|
19
21
|
"marked": "^4.0.18",
|
|
20
|
-
"chalk": "^4.1.2",
|
|
21
|
-
"rehype": "^9.0.1",
|
|
22
|
-
"rehype-format": "^3.1.0",
|
|
23
|
-
"rehype-highlight": "^4.1.0",
|
|
24
|
-
"hast-util-to-string": "^1.0.4",
|
|
25
|
-
"unist-util-visit": "^2.0.1",
|
|
26
|
-
"github-slugger": "^1.5.0",
|
|
27
|
-
"hast-util-heading-rank": "^1.0.1",
|
|
28
|
-
"hast-util-has-property": "^1.0.4",
|
|
29
22
|
"highlight.js": "^11.5.1",
|
|
30
23
|
"raw-loader": "^4.0.2",
|
|
31
24
|
"esbuild": "^0.17.8",
|
|
@@ -56,6 +49,6 @@
|
|
|
56
49
|
"bugs": {
|
|
57
50
|
"url": "https://github.com/skoropadas/ng-doc/issues"
|
|
58
51
|
},
|
|
59
|
-
"homepage": "https://ng-doc.com
|
|
52
|
+
"homepage": "https://ng-doc.com",
|
|
60
53
|
"license": "MIT"
|
|
61
54
|
}
|
|
@@ -1,16 +1,22 @@
|
|
|
1
1
|
{% import "helpers/declaration-modifiers.html.nunj" as tagsMacro %}
|
|
2
2
|
{% import "helpers/no-content.html.nunj" as noContentMacro %}
|
|
3
3
|
|
|
4
|
+
{% set description = docNode | extractDocs %}
|
|
5
|
+
|
|
4
6
|
<header>
|
|
5
7
|
{% include "parts/page-tags.html.nunj" %}
|
|
6
8
|
{% block modifier %}{% endblock %}
|
|
7
9
|
<h1>{{ declaration.getName() }}</h1>
|
|
10
|
+
|
|
11
|
+
{% if not description %}
|
|
12
|
+
<!-- This is a hack to make the declaration name available to the search index. -->
|
|
13
|
+
<div style="display: none">%%API_NAME_ANCHOR%%</div>
|
|
14
|
+
{% endif %}
|
|
15
|
+
|
|
8
16
|
{% block details %}{% endblock %}
|
|
9
17
|
</header>
|
|
10
18
|
|
|
11
19
|
<section>
|
|
12
|
-
{% set description = docNode | extractDocs %}
|
|
13
|
-
|
|
14
20
|
{{ description if description else noContentMacro.render('No documentation has been provided.') }}
|
|
15
21
|
</section>
|
|
16
22
|
|
|
@@ -16,7 +16,7 @@
|
|
|
16
16
|
{% set implements = declaration.getImplements() %}
|
|
17
17
|
|
|
18
18
|
{% if extends or implements.length %}
|
|
19
|
-
<div class="ng-doc-header-details">
|
|
19
|
+
<div class="ng-doc-header-details" indexable="false">
|
|
20
20
|
{% if extends %}
|
|
21
21
|
<span class="ng-doc-header-details-label">Extends</span>
|
|
22
22
|
{{ typeMacro.render(extends.getType()) }}
|
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
{%- set extends = declaration.getExtends() -%}
|
|
10
10
|
|
|
11
11
|
{% if extends.length %}
|
|
12
|
-
<div class="ng-doc-header-details">
|
|
12
|
+
<div class="ng-doc-header-details" indexable="false">
|
|
13
13
|
<span class="ng-doc-header-details-label">Extends</span>
|
|
14
14
|
{%- for i in extends -%}
|
|
15
15
|
{{ typeMacro.render(i.getType()) }}
|
|
@@ -12,6 +12,7 @@ import pageContent from '!!raw-loader!{{ page.builtPagePath }}';
|
|
|
12
12
|
providers: [{provide: NgDocRootPage, useExisting: DynamicComponent}],
|
|
13
13
|
})
|
|
14
14
|
export class DynamicComponent extends NgDocRootPage {
|
|
15
|
+
readonly routePrefix?: string = undefined;
|
|
15
16
|
readonly pageType: NgDocPageType = 'api';
|
|
16
17
|
{%- if page.editSourceFileUrl %}
|
|
17
18
|
readonly editSourceFileUrl: string = '{{ page.editSourceFileUrl }}';
|
|
@@ -19,7 +19,7 @@
|
|
|
19
19
|
<table class="ng-doc-accessor-table">
|
|
20
20
|
<thead>
|
|
21
21
|
<tr>
|
|
22
|
-
<th>
|
|
22
|
+
<th indexable="false">
|
|
23
23
|
{{ decoratorsMacro.render(accessor.getDecorators()) if accessor.getDecorators }}
|
|
24
24
|
{{ tagsMacro.render(accessor, 'modifier') }}
|
|
25
25
|
<h3>{{ modifierMacro.render(type) }} {{ accessor.getName() }}</h3>
|
|
@@ -44,13 +44,13 @@
|
|
|
44
44
|
</td>
|
|
45
45
|
</tr>
|
|
46
46
|
<tr>
|
|
47
|
-
<td>
|
|
47
|
+
<td indexable="false">
|
|
48
48
|
<h5 class="no-anchor">Presentation</h5>
|
|
49
49
|
{{ codeMacro.render(accessor | accessorPresentation, "typescript", false) }}
|
|
50
50
|
</td>
|
|
51
51
|
</tr>
|
|
52
52
|
<tr>
|
|
53
|
-
<td>
|
|
53
|
+
<td indexable="false">
|
|
54
54
|
<h5 class="no-anchor">Type</h5>
|
|
55
55
|
<p>
|
|
56
56
|
{{ typeMacro.render(accessor.getType()) }}
|
|
@@ -1,3 +1,3 @@
|
|
|
1
1
|
{%- macro render(content, attributeOverride) -%}
|
|
2
|
-
<span class="ng-doc-badge" data-content="{{ attributeOverride if attributeOverride else content }}">{{ content[0] }}</span>
|
|
2
|
+
<span class="ng-doc-badge" indexable="false" data-content="{{ attributeOverride if attributeOverride else content }}">{{ content[0] }}</span>
|
|
3
3
|
{%- endmacro -%}
|
|
@@ -16,14 +16,14 @@
|
|
|
16
16
|
</tr>
|
|
17
17
|
<tr>
|
|
18
18
|
<td>
|
|
19
|
-
<h5 class="no-anchor">Presentation</h5>
|
|
19
|
+
<h5 class="no-anchor" indexable="false">Presentation</h5>
|
|
20
20
|
{{ codeMacro.render(constructor | constructorPresentation, "typescript", false) }}
|
|
21
21
|
</td>
|
|
22
22
|
</tr>
|
|
23
23
|
<tr>
|
|
24
24
|
<td>
|
|
25
25
|
{%- if parameters.length %}
|
|
26
|
-
<h5 class="no-anchor">Parameters</h5>
|
|
26
|
+
<h5 class="no-anchor" indexable="false">Parameters</h5>
|
|
27
27
|
{{ parametersMacro.render(parameters, constructor) }}
|
|
28
28
|
{%- endif %}
|
|
29
29
|
</td>
|
|
@@ -12,7 +12,7 @@
|
|
|
12
12
|
|
|
13
13
|
{%- if type == 'badge' %}
|
|
14
14
|
{%- if isAbstract or isStatic or isAsync or isReadonly or isProtected %}
|
|
15
|
-
<span class="ng-doc-badge-wrapper" ngDocTooltip="{{ tooltip }}">
|
|
15
|
+
<span class="ng-doc-badge-wrapper" ngDocTooltip="{{ tooltip }}" indexable="false">
|
|
16
16
|
{{ badgeMacro.render("protected") if isProtected }}
|
|
17
17
|
{{ badgeMacro.render("abstract") if isAbstract }}
|
|
18
18
|
{{ badgeMacro.render("static") if isStatic }}
|
|
@@ -23,7 +23,7 @@
|
|
|
23
23
|
|
|
24
24
|
{%- elseif type == 'modifier' %}
|
|
25
25
|
{%- if isAbstract or isStatic or isAsync or isReadonly or isProtected %}
|
|
26
|
-
<div class="ng-doc-modifiers-wrapper">
|
|
26
|
+
<div class="ng-doc-modifiers-wrapper" indexable="false">
|
|
27
27
|
{{ modifierMacro.render("protected") if isProtected }}
|
|
28
28
|
{{ modifierMacro.render("abstract") if isAbstract }}
|
|
29
29
|
{{ modifierMacro.render("static") if isStatic }}
|
|
@@ -33,7 +33,7 @@
|
|
|
33
33
|
{%- endif %}
|
|
34
34
|
{%- else %}
|
|
35
35
|
{%- if isAbstract or isStatic or isAsync or isReadonly or isProtected %}
|
|
36
|
-
<span class="ng-doc-tags-wrapper">
|
|
36
|
+
<span class="ng-doc-tags-wrapper" indexable="false">
|
|
37
37
|
{{ tagMacro.render("protected") if isProtected }}
|
|
38
38
|
{{ tagMacro.render("abstract") if isAbstract }}
|
|
39
39
|
{{ tagMacro.render("static") if isStatic }}
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
{% macro render(decorators, column) %}
|
|
4
4
|
{% if decorators.length %}
|
|
5
|
-
<div class="ng-doc-decorators-group {{ 'column' if column }}">
|
|
5
|
+
<div class="ng-doc-decorators-group {{ 'column' if column }}" indexable="false">
|
|
6
6
|
{% for decorator in decorators %}
|
|
7
7
|
{{ tagMacro.render('@' + decorator.getName(), decorator.getName()) }}
|
|
8
8
|
{%- endfor %}
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
<div class="ng-doc-table-wrapper">
|
|
3
3
|
<table>
|
|
4
4
|
<thead>
|
|
5
|
-
<tr>
|
|
5
|
+
<tr indexable="false">
|
|
6
6
|
<th>Name</th>
|
|
7
7
|
<th>Value</th>
|
|
8
8
|
<th>Description</th>
|
|
@@ -11,8 +11,8 @@
|
|
|
11
11
|
<tbody>
|
|
12
12
|
{% for member in members %}
|
|
13
13
|
<tr>
|
|
14
|
-
<td>{{ member.getName() }} </td>
|
|
15
|
-
<td><code>{{ member.getValue() | dump }}</code></td>
|
|
14
|
+
<td indexable="false">{{ member.getName() }} </td>
|
|
15
|
+
<td indexable="false"><code>{{ member.getValue() | dump }}</code></td>
|
|
16
16
|
<td>{{ member | extractDocs }} </td>
|
|
17
17
|
</tr>
|
|
18
18
|
{% endfor %}
|
|
@@ -17,7 +17,7 @@
|
|
|
17
17
|
<table class="ng-doc-method-table">
|
|
18
18
|
<thead>
|
|
19
19
|
<tr>
|
|
20
|
-
<th>
|
|
20
|
+
<th indexable="false">
|
|
21
21
|
{{ decoratorsMacro.render(method.getDecorators()) if method.getDecorators }}
|
|
22
22
|
{{ tagsMacro.render(method, 'modifier') }}
|
|
23
23
|
<h3>{{ method.getName() }}()</h3>
|
|
@@ -43,17 +43,17 @@
|
|
|
43
43
|
</tr>
|
|
44
44
|
<tr>
|
|
45
45
|
<td>
|
|
46
|
-
<h5 class="no-anchor">Presentation</h5>
|
|
46
|
+
<h5 class="no-anchor" indexable="false">Presentation</h5>
|
|
47
47
|
{{ codeMacro.render(method | methodPresentation, "typescript", false) }}
|
|
48
48
|
</td>
|
|
49
49
|
</tr>
|
|
50
50
|
<tr>
|
|
51
51
|
<td>
|
|
52
52
|
{%- if parameters.length %}
|
|
53
|
-
<h5 class="no-anchor">Parameters</h5>
|
|
53
|
+
<h5 class="no-anchor" indexable="false">Parameters</h5>
|
|
54
54
|
{{ parametersMacro.render(parameters, docNode) }}
|
|
55
55
|
{%- endif %}
|
|
56
|
-
<h5 class="no-anchor">Returns</h5>
|
|
56
|
+
<h5 class="no-anchor" indexable="false">Returns</h5>
|
|
57
57
|
<p>
|
|
58
58
|
{{ typeMacro.render(method.getReturnType()) }}
|
|
59
59
|
</p>
|
|
@@ -1,3 +1,3 @@
|
|
|
1
1
|
{%- macro render(content, attributeOverride) -%}
|
|
2
|
-
<span class="ng-doc-modifier" data-content="{{ attributeOverride if attributeOverride else content }}">{{ content }}</span>
|
|
2
|
+
<span class="ng-doc-modifier" indexable="false" data-content="{{ attributeOverride if attributeOverride else content }}">{{ content }}</span>
|
|
3
3
|
{%- endmacro -%}
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
<div class="ng-doc-table-wrapper">
|
|
7
7
|
<table class="ng-doc-parameters-table">
|
|
8
8
|
<thead>
|
|
9
|
-
<tr>
|
|
9
|
+
<tr indexable="false">
|
|
10
10
|
<th class="ng-doc-parameters-table-name">Name</th>
|
|
11
11
|
<th class="ng-doc-parameters-table-type">Type</th>
|
|
12
12
|
<th class="ng-doc-parameters-table-description">Description</th>
|
|
@@ -21,7 +21,7 @@
|
|
|
21
21
|
{% set docNode = paramChain | firstNodeWithComment %}
|
|
22
22
|
|
|
23
23
|
<tr>
|
|
24
|
-
<td>
|
|
24
|
+
<td indexable="false">
|
|
25
25
|
{{ decoratorsMacro.render(param.getDecorators(), true) if param.getDecorators }}
|
|
26
26
|
{{ tagsMacro.render(param, "badge") }}{{ param.getName() }}
|
|
27
27
|
<div class="ng-doc-node-details">
|
|
@@ -34,7 +34,7 @@
|
|
|
34
34
|
{%- endif %}
|
|
35
35
|
</div>
|
|
36
36
|
</td>
|
|
37
|
-
<td>{{ typeMacro.
|
|
37
|
+
<td>{{ typeMacro.renderNode(param.getTypeNode()) }}</td>
|
|
38
38
|
<td>{{ origin | extractParameterDocs(param.getName()) }}</td>
|
|
39
39
|
</tr>
|
|
40
40
|
{%- endfor %}
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
<div class="ng-doc-table-wrapper">
|
|
7
7
|
<table class="ng-doc-properties-table">
|
|
8
8
|
<thead>
|
|
9
|
-
<tr>
|
|
9
|
+
<tr indexable="false">
|
|
10
10
|
<th class="ng-doc-properties-table-name">Name</th>
|
|
11
11
|
<th class="ng-doc-properties-table-type">Type</th>
|
|
12
12
|
<th class="ng-doc-properties-table-description">Description</th>
|
|
@@ -21,7 +21,7 @@
|
|
|
21
21
|
{% set docNode = propertyChain | firstNodeWithComment %}
|
|
22
22
|
|
|
23
23
|
<tr>
|
|
24
|
-
<td>
|
|
24
|
+
<td indexable="false">
|
|
25
25
|
{{ decoratorsMacro.render(property.getDecorators(), true) if property.getDecorators }}
|
|
26
26
|
{{ tagsMacro.render(property, "badge") }}{{ property.getName() }}
|
|
27
27
|
<div class="ng-doc-node-details">
|
|
@@ -34,7 +34,7 @@
|
|
|
34
34
|
{%- endif %}
|
|
35
35
|
</div>
|
|
36
36
|
</td>
|
|
37
|
-
<td>{{ typeMacro.
|
|
37
|
+
<td>{{ typeMacro.renderNode(property.getTypeNode()) }}</td>
|
|
38
38
|
<td>{{ docNode | extractDocs }}</td>
|
|
39
39
|
</tr>
|
|
40
40
|
{%- endfor %}
|
|
@@ -1,3 +1,3 @@
|
|
|
1
1
|
{%- macro render(content, attributeOverride) -%}
|
|
2
|
-
<span class="ng-doc-tag" data-content="{{ attributeOverride if attributeOverride else content }}">{{ content }}</span>
|
|
2
|
+
<span class="ng-doc-tag" indexable="false" data-content="{{ attributeOverride if attributeOverride else content }}">{{ content }}</span>
|
|
3
3
|
{%- endmacro -%}
|
|
@@ -1,3 +1,7 @@
|
|
|
1
1
|
{% macro render(type) -%}
|
|
2
|
-
<code>{{ type | displayType | escape }}</code>
|
|
2
|
+
<code indexable="false">{{ type | displayType | escape }}</code>
|
|
3
|
+
{%- endmacro %}
|
|
4
|
+
|
|
5
|
+
{%- macro renderNode(type) -%}
|
|
6
|
+
<code indexable="false">{{ type | displayTypeNode | escape }}</code>
|
|
3
7
|
{%- endmacro %}
|
|
@@ -22,6 +22,7 @@ import demoAssets from '{{ page.componentsAssets }}';
|
|
|
22
22
|
providers: [{provide: NgDocRootPage, useExisting: DynamicComponent}],
|
|
23
23
|
})
|
|
24
24
|
export class DynamicComponent extends NgDocRootPage {
|
|
25
|
+
readonly routePrefix: string = '{{ page.context.config.routePrefix }}';
|
|
25
26
|
readonly pageType: NgDocPageType = 'guide';
|
|
26
27
|
readonly pageContent: string = pageContent;
|
|
27
28
|
|
|
@@ -7,18 +7,18 @@
|
|
|
7
7
|
|
|
8
8
|
|
|
9
9
|
{{ tagMacro.render(scope.name, "ng-doc-scope") }}
|
|
10
|
-
<span class="ng-doc-inline-delimiter">/</span>
|
|
10
|
+
<span class="ng-doc-inline-delimiter" indexable="false">/</span>
|
|
11
11
|
{{ tagMacro.render(declarationType) if declarationType }}
|
|
12
12
|
|
|
13
13
|
|
|
14
14
|
{%- if declaration.getDecorators and declaration.getDecorators().length %}
|
|
15
|
-
<span class="ng-doc-inline-delimiter">/</span>
|
|
15
|
+
<span class="ng-doc-inline-delimiter" indexable="false">/</span>
|
|
16
16
|
{{ decoratorsMacro.render(declaration.getDecorators()) }}
|
|
17
17
|
{%- endif %}
|
|
18
18
|
|
|
19
19
|
|
|
20
20
|
{% for selector in selectors %}
|
|
21
|
-
<span class="ng-doc-inline-delimiter">/</span>
|
|
21
|
+
<span class="ng-doc-inline-delimiter" indexable="false">/</span>
|
|
22
22
|
{{ tagMacro.render(selector, "ng-doc-tag-selector") }}
|
|
23
23
|
{%- endfor %}
|
|
24
24
|
</div>
|
package/types/action.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
1
|
import { Project } from 'ts-morph';
|
|
2
2
|
import { NgDocPageEntity } from '../engine';
|
|
3
3
|
import { NgDocActionOutput } from '../interfaces';
|
|
4
|
-
export
|
|
4
|
+
export type NgDocAction = (project: Project, page: NgDocPageEntity) => NgDocActionOutput;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
export
|
|
1
|
+
export type NgDocArtifactProcessor = (artifact: string, type: string) => string;
|
|
@@ -1,2 +1,2 @@
|
|
|
1
1
|
import { NgDocAsset } from '../interfaces';
|
|
2
|
-
export
|
|
2
|
+
export type NgDocComponentAsset = Record<string, NgDocAsset[]>;
|
package/types/index.d.ts
CHANGED
package/types/index.js
CHANGED
|
@@ -5,7 +5,6 @@ tslib_1.__exportStar(require("./action"), exports);
|
|
|
5
5
|
tslib_1.__exportStar(require("./artifact-processor"), exports);
|
|
6
6
|
tslib_1.__exportStar(require("./component-asset"), exports);
|
|
7
7
|
tslib_1.__exportStar(require("./constructable"), exports);
|
|
8
|
-
tslib_1.__exportStar(require("./keyword-type"), exports);
|
|
9
8
|
tslib_1.__exportStar(require("./snippet-type"), exports);
|
|
10
9
|
tslib_1.__exportStar(require("./supported-declarations"), exports);
|
|
11
10
|
//# sourceMappingURL=index.js.map
|
package/types/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../libs/builder/types/index.ts"],"names":[],"mappings":";;;AAAA,mDAAyB;AACzB,+DAAqC;AACrC,4DAAkC;AAClC,0DAAgC;AAChC,yDAA+B;AAC/B,
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../libs/builder/types/index.ts"],"names":[],"mappings":";;;AAAA,mDAAyB;AACzB,+DAAqC;AACrC,4DAAkC;AAClC,0DAAgC;AAChC,yDAA+B;AAC/B,mEAAyC"}
|
package/types/snippet-type.d.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export
|
|
1
|
+
export type NgDocSnippetType = 'TypeScript' | 'HTML' | 'styles';
|
|
@@ -1,2 +1,2 @@
|
|
|
1
1
|
import { ClassDeclaration, EnumDeclaration, FunctionDeclaration, InterfaceDeclaration, ModuleDeclaration, TypeAliasDeclaration, VariableDeclaration } from 'ts-morph';
|
|
2
|
-
export
|
|
2
|
+
export type NgDocSupportedDeclarations = ClassDeclaration | InterfaceDeclaration | EnumDeclaration | FunctionDeclaration | VariableDeclaration | TypeAliasDeclaration | ModuleDeclaration;
|
|
@@ -1,40 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
const is = require('hast-util-is-element');
|
|
4
|
-
const visit = require('unist-util-visit-parents');
|
|
5
|
-
const HEADINGS = ['h1', 'h2', 'h3', 'h4', 'h5', 'h6'];
|
|
6
|
-
const NO_ANCHOR_CLASS = 'no-anchor';
|
|
7
|
-
const hasClass = (node, cls) => {
|
|
8
|
-
const className = node.properties.className;
|
|
9
|
-
return className && className.includes(cls);
|
|
10
|
-
};
|
|
11
|
-
/**
|
|
12
|
-
*
|
|
13
|
-
* @param options
|
|
14
|
-
* @param parentRoute
|
|
15
|
-
*/
|
|
16
|
-
function autolinkHeading(parentRoute) {
|
|
17
|
-
return (tree) => visit(tree, 'element', (node) => {
|
|
18
|
-
if (parentRoute && is(node, HEADINGS) && node.properties.id && !hasClass(node, NO_ANCHOR_CLASS)) {
|
|
19
|
-
node.children.push({
|
|
20
|
-
type: 'element',
|
|
21
|
-
tagName: 'a',
|
|
22
|
-
properties: {
|
|
23
|
-
title: 'Link to heading',
|
|
24
|
-
className: ['ng-doc-header-link'],
|
|
25
|
-
href: `${parentRoute}#${node.properties.id}`
|
|
26
|
-
},
|
|
27
|
-
children: [{
|
|
28
|
-
type: 'element',
|
|
29
|
-
tagName: 'ng-doc-icon',
|
|
30
|
-
properties: {
|
|
31
|
-
icon: "link-2",
|
|
32
|
-
size: 16,
|
|
33
|
-
},
|
|
34
|
-
}]
|
|
35
|
-
});
|
|
36
|
-
}
|
|
37
|
-
});
|
|
38
|
-
}
|
|
39
|
-
exports.default = autolinkHeading;
|
|
40
|
-
//# sourceMappingURL=autolink-headings.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"autolink-headings.js","sourceRoot":"","sources":["../../../../../../libs/builder/engine/post-processors/html-plugins/autolink-headings.ts"],"names":[],"mappings":";;AAAA,MAAM,EAAE,GAAQ,OAAO,CAAC,sBAAsB,CAAC,CAAC;AAChD,MAAM,KAAK,GAAQ,OAAO,CAAC,0BAA0B,CAAC,CAAC;AAEvD,MAAM,QAAQ,GAAa,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;AAChE,MAAM,eAAe,GAAW,WAAW,CAAC;AAE5C,MAAM,QAAQ,GAAQ,CAAC,IAAS,EAAE,GAAQ,EAAE,EAAE;IAC7C,MAAM,SAAS,GAAW,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC;IACpD,OAAO,SAAS,IAAI,SAAS,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;AAC7C,CAAC,CAAC;AAGF;;;;GAIG;AACH,SAAwB,eAAe,CAAC,WAAoB;IAC3D,OAAO,CAAC,IAAS,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,EAAE,SAAS,EAAE,CAAC,IAAS,EAAE,EAAE;QAC1D,IAAI,WAAW,IAAI,EAAE,CAAC,IAAI,EAAE,QAAQ,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,eAAe,CAAC,EAAE;YAChG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC;gBAClB,IAAI,EAAE,SAAS;gBACf,OAAO,EAAE,GAAG;gBACZ,UAAU,EAAE;oBACX,KAAK,EAAE,iBAAiB;oBACxB,SAAS,EAAE,CAAC,oBAAoB,CAAC;oBACjC,IAAI,EAAE,GAAG,WAAW,IAAI,IAAI,CAAC,UAAU,CAAC,EAAE,EAAE;iBAC5C;gBACD,QAAQ,EAAE,CAAC;wBACV,IAAI,EAAE,SAAS;wBACf,OAAO,EAAE,aAAa;wBACtB,UAAU,EAAE;4BACX,IAAI,EAAE,QAAQ;4BACd,IAAI,EAAE,EAAE;yBACR;qBACD,CAAC;aACF,CAAC,CAAC;SACH;IACF,CAAC,CAAC,CAAA;AACH,CAAC;AAtBD,kCAsBC"}
|
|
@@ -1,40 +0,0 @@
|
|
|
1
|
-
const is: any = require('hast-util-is-element');
|
|
2
|
-
const visit: any = require('unist-util-visit-parents');
|
|
3
|
-
|
|
4
|
-
const HEADINGS: string[] = ['h1', 'h2', 'h3', 'h4', 'h5', 'h6'];
|
|
5
|
-
const NO_ANCHOR_CLASS: string = 'no-anchor';
|
|
6
|
-
|
|
7
|
-
const hasClass: any = (node: any, cls: any) => {
|
|
8
|
-
const className: string = node.properties.className;
|
|
9
|
-
return className && className.includes(cls);
|
|
10
|
-
};
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
/**
|
|
14
|
-
*
|
|
15
|
-
* @param options
|
|
16
|
-
* @param parentRoute
|
|
17
|
-
*/
|
|
18
|
-
export default function autolinkHeading(parentRoute?: string): any {
|
|
19
|
-
return (tree: any) => visit(tree, 'element', (node: any) => {
|
|
20
|
-
if (parentRoute && is(node, HEADINGS) && node.properties.id && !hasClass(node, NO_ANCHOR_CLASS)) {
|
|
21
|
-
node.children.push({
|
|
22
|
-
type: 'element',
|
|
23
|
-
tagName: 'a',
|
|
24
|
-
properties: {
|
|
25
|
-
title: 'Link to heading',
|
|
26
|
-
className: ['ng-doc-header-link'],
|
|
27
|
-
href: `${parentRoute}#${node.properties.id}`
|
|
28
|
-
},
|
|
29
|
-
children: [{
|
|
30
|
-
type: 'element',
|
|
31
|
-
tagName: 'ng-doc-icon',
|
|
32
|
-
properties: {
|
|
33
|
-
icon: "link-2",
|
|
34
|
-
size: 16,
|
|
35
|
-
},
|
|
36
|
-
}]
|
|
37
|
-
});
|
|
38
|
-
}
|
|
39
|
-
})
|
|
40
|
-
}
|
|
@@ -1,8 +0,0 @@
|
|
|
1
|
-
import { NgDocRouteEntity } from '../../entities/abstractions/route.entity';
|
|
2
|
-
import { NgDocEntityStore } from '../../entity-store';
|
|
3
|
-
/**
|
|
4
|
-
*
|
|
5
|
-
* @param entityStore
|
|
6
|
-
* @param entity
|
|
7
|
-
*/
|
|
8
|
-
export default function keywordsProcessor(entityStore: NgDocEntityStore, entity?: NgDocRouteEntity): any;
|