@ng-doc/builder 18.1.1 → 18.2.0

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.
Files changed (41) hide show
  1. package/engine/.cache/apps/ng-doc/docs/api-documentation/auto-generation/ng-doc.page.mjs +20 -0
  2. package/engine/.cache/apps/ng-doc/docs/api-documentation/documenting-declarations/ng-doc.page.mjs +20 -0
  3. package/engine/.cache/apps/ng-doc/docs/api-documentation/rendering-api/ng-doc.page.mjs +19 -0
  4. package/engine/.cache/apps/ng-doc/docs/customization/icons/ng-doc.page.mjs +19 -0
  5. package/engine/.cache/apps/ng-doc/docs/customization/layout/ng-doc.page.mjs +19 -0
  6. package/engine/.cache/apps/ng-doc/docs/customization/page-processors/ng-doc.page.mjs +19 -0
  7. package/engine/.cache/apps/ng-doc/docs/customization/page-skeleton/ng-doc.page.mjs +19 -0
  8. package/engine/.cache/apps/ng-doc/docs/customization/search/ng-doc.page.mjs +19 -0
  9. package/engine/.cache/apps/ng-doc/docs/customization/themes/ng-doc.page.mjs +19 -0
  10. package/engine/.cache/apps/ng-doc/docs/develop/ng-doc.page.mjs +36 -0
  11. package/engine/.cache/apps/ng-doc/docs/getting-started/configuration/ng-doc.page.mjs +19 -0
  12. package/engine/.cache/apps/ng-doc/docs/getting-started/installation/ng-doc.page.mjs +19 -0
  13. package/engine/.cache/apps/ng-doc/docs/getting-started/migrations/ng-doc.page.mjs +18 -0
  14. package/engine/.cache/apps/ng-doc/docs/getting-started/ssr/ng-doc.page.mjs +19 -0
  15. package/engine/.cache/apps/ng-doc/docs/getting-started/what-is-ng-doc/ng-doc.page.mjs +19 -0
  16. package/engine/.cache/apps/ng-doc/docs/ng-doc.api.mjs +42 -0
  17. package/engine/.cache/apps/ng-doc/docs/recipes/ignoring-file-lines/ng-doc.page.mjs +18 -0
  18. package/engine/.cache/apps/ng-doc/docs/recipes/performance/ng-doc.page.mjs +19 -0
  19. package/engine/.cache/apps/ng-doc/docs/writing-content/blockquotes/ng-doc.page.mjs +18 -0
  20. package/engine/.cache/apps/ng-doc/docs/writing-content/code-blocks/ng-doc.page.mjs +18 -0
  21. package/engine/.cache/apps/ng-doc/docs/writing-content/demo-and-demo-pane/ng-doc.page.mjs +19 -0
  22. package/engine/.cache/apps/ng-doc/docs/writing-content/images-videos-and-embeds/ng-doc.page.mjs +18 -0
  23. package/engine/.cache/apps/ng-doc/docs/writing-content/keywords/ng-doc.page.mjs +17 -0
  24. package/engine/.cache/apps/ng-doc/docs/writing-content/mermaid-diagrams/ng-doc.page.mjs +18 -0
  25. package/engine/.cache/apps/ng-doc/docs/writing-content/nunjucks/ng-doc.page.mjs +18 -0
  26. package/engine/.cache/apps/ng-doc/docs/writing-content/pages-and-categories/ng-doc.page.mjs +18 -0
  27. package/engine/.cache/apps/ng-doc/docs/writing-content/playground/ng-doc.page.mjs +33 -0
  28. package/engine/nunjucks/actions/api.action.js +2 -0
  29. package/engine/nunjucks/actions/api.action.js.map +1 -1
  30. package/package.json +4 -4
  31. package/templates/api/base.html.nunj +8 -0
  32. package/templates/api/function-declaration.html.nunj +11 -0
  33. package/templates/helpers/accessor.html.nunj +2 -0
  34. package/templates/helpers/method.html.nunj +12 -2
  35. package/templates/helpers/overload.html.nunj +12 -2
  36. package/templates/helpers/properties.html.nunj +6 -0
  37. package/templates/page-wrapper.ts.nunj +1 -1
  38. package/templates/parts/examples.html.nunj +11 -0
  39. package/templates/parts/member-examples.html.nunj +12 -0
  40. package/templates/parts/member-remarks.html.nunj +8 -0
  41. package/templates/parts/remarks.html.nunj +10 -0
@@ -0,0 +1,20 @@
1
+ // apps/ng-doc/docs/api-documentation/ng-doc.category.ts
2
+ var ApiDocumentationCategory = {
3
+ title: "API Documentation",
4
+ route: "api-documentation",
5
+ expandable: true,
6
+ order: 4
7
+ };
8
+ var ng_doc_category_default = ApiDocumentationCategory;
9
+
10
+ // apps/ng-doc/docs/api-documentation/auto-generation/apps/ng-doc/docs/api-documentation/auto-generation/ng-doc.page.ts
11
+ var AutoGenerationPage = {
12
+ title: "Auto generation",
13
+ mdFile: "./index.md",
14
+ category: ng_doc_category_default,
15
+ order: 1
16
+ };
17
+ var ng_doc_page_default = AutoGenerationPage;
18
+ export {
19
+ ng_doc_page_default as default
20
+ };
@@ -0,0 +1,20 @@
1
+ // apps/ng-doc/docs/api-documentation/ng-doc.category.ts
2
+ var ApiDocumentationCategory = {
3
+ title: "API Documentation",
4
+ route: "api-documentation",
5
+ expandable: true,
6
+ order: 4
7
+ };
8
+ var ng_doc_category_default = ApiDocumentationCategory;
9
+
10
+ // apps/ng-doc/docs/api-documentation/documenting-declarations/apps/ng-doc/docs/api-documentation/documenting-declarations/ng-doc.page.ts
11
+ var DocumentingDeclarationsPage = {
12
+ title: "Documenting declarations",
13
+ mdFile: "./index.md",
14
+ category: ng_doc_category_default,
15
+ order: 2
16
+ };
17
+ var ng_doc_page_default = DocumentingDeclarationsPage;
18
+ export {
19
+ ng_doc_page_default as default
20
+ };
@@ -0,0 +1,19 @@
1
+ // apps/ng-doc/docs/api-documentation/ng-doc.category.ts
2
+ var ApiDocumentationCategory = {
3
+ title: "API Documentation",
4
+ route: "api-documentation",
5
+ expandable: true,
6
+ order: 4
7
+ };
8
+ var ng_doc_category_default = ApiDocumentationCategory;
9
+
10
+ // apps/ng-doc/docs/api-documentation/rendering-api/apps/ng-doc/docs/api-documentation/rendering-api/ng-doc.page.ts
11
+ var RenderingAPIPage = {
12
+ title: `Rendering API`,
13
+ mdFile: "./index.md",
14
+ category: ng_doc_category_default
15
+ };
16
+ var ng_doc_page_default = RenderingAPIPage;
17
+ export {
18
+ ng_doc_page_default as default
19
+ };
@@ -0,0 +1,19 @@
1
+ // apps/ng-doc/docs/customization/ng-doc.category.ts
2
+ var CustomizationCategory = {
3
+ title: "Customization",
4
+ order: 6,
5
+ expandable: true
6
+ };
7
+ var ng_doc_category_default = CustomizationCategory;
8
+
9
+ // apps/ng-doc/docs/customization/icons/apps/ng-doc/docs/customization/icons/ng-doc.page.ts
10
+ var IconsPage = {
11
+ title: `Icons`,
12
+ mdFile: "./index.md",
13
+ category: ng_doc_category_default,
14
+ order: 4
15
+ };
16
+ var ng_doc_page_default = IconsPage;
17
+ export {
18
+ ng_doc_page_default as default
19
+ };
@@ -0,0 +1,19 @@
1
+ // apps/ng-doc/docs/customization/ng-doc.category.ts
2
+ var CustomizationCategory = {
3
+ title: "Customization",
4
+ order: 6,
5
+ expandable: true
6
+ };
7
+ var ng_doc_category_default = CustomizationCategory;
8
+
9
+ // apps/ng-doc/docs/customization/layout/apps/ng-doc/docs/customization/layout/ng-doc.page.ts
10
+ var LayoutPage = {
11
+ title: `Layout`,
12
+ mdFile: "./index.md",
13
+ category: ng_doc_category_default,
14
+ order: 2
15
+ };
16
+ var ng_doc_page_default = LayoutPage;
17
+ export {
18
+ ng_doc_page_default as default
19
+ };
@@ -0,0 +1,19 @@
1
+ // apps/ng-doc/docs/customization/ng-doc.category.ts
2
+ var CustomizationCategory = {
3
+ title: "Customization",
4
+ order: 6,
5
+ expandable: true
6
+ };
7
+ var ng_doc_category_default = CustomizationCategory;
8
+
9
+ // apps/ng-doc/docs/customization/page-processors/apps/ng-doc/docs/customization/page-processors/ng-doc.page.ts
10
+ var PageProcessorsPage = {
11
+ title: `Page Processors`,
12
+ mdFile: "./index.md",
13
+ category: ng_doc_category_default,
14
+ order: 1
15
+ };
16
+ var ng_doc_page_default = PageProcessorsPage;
17
+ export {
18
+ ng_doc_page_default as default
19
+ };
@@ -0,0 +1,19 @@
1
+ // apps/ng-doc/docs/customization/ng-doc.category.ts
2
+ var CustomizationCategory = {
3
+ title: "Customization",
4
+ order: 6,
5
+ expandable: true
6
+ };
7
+ var ng_doc_category_default = CustomizationCategory;
8
+
9
+ // apps/ng-doc/docs/customization/page-skeleton/apps/ng-doc/docs/customization/page-skeleton/ng-doc.page.ts
10
+ var PageSkeletonPage = {
11
+ title: `Page Skeleton`,
12
+ mdFile: "./index.md",
13
+ category: ng_doc_category_default,
14
+ order: 1
15
+ };
16
+ var ng_doc_page_default = PageSkeletonPage;
17
+ export {
18
+ ng_doc_page_default as default
19
+ };
@@ -0,0 +1,19 @@
1
+ // apps/ng-doc/docs/customization/ng-doc.category.ts
2
+ var CustomizationCategory = {
3
+ title: "Customization",
4
+ order: 6,
5
+ expandable: true
6
+ };
7
+ var ng_doc_category_default = CustomizationCategory;
8
+
9
+ // apps/ng-doc/docs/customization/search/apps/ng-doc/docs/customization/search/ng-doc.page.ts
10
+ var SearchPage = {
11
+ title: "Search",
12
+ mdFile: "./index.md",
13
+ order: 2,
14
+ category: ng_doc_category_default
15
+ };
16
+ var ng_doc_page_default = SearchPage;
17
+ export {
18
+ ng_doc_page_default as default
19
+ };
@@ -0,0 +1,19 @@
1
+ // apps/ng-doc/docs/customization/ng-doc.category.ts
2
+ var CustomizationCategory = {
3
+ title: "Customization",
4
+ order: 6,
5
+ expandable: true
6
+ };
7
+ var ng_doc_category_default = CustomizationCategory;
8
+
9
+ // apps/ng-doc/docs/customization/themes/apps/ng-doc/docs/customization/themes/ng-doc.page.ts
10
+ var ThemesPage = {
11
+ title: "Themes",
12
+ mdFile: "./index.md",
13
+ category: ng_doc_category_default,
14
+ order: 3
15
+ };
16
+ var ng_doc_page_default = ThemesPage;
17
+ export {
18
+ ng_doc_page_default as default
19
+ };
@@ -0,0 +1,36 @@
1
+ // libs/core/constants/angular-entities.ts
2
+ var NgDocAngularEntities = [
3
+ "Component",
4
+ "Directive",
5
+ "Pipe",
6
+ "Injectable",
7
+ "NgModule"
8
+ ];
9
+
10
+ // libs/core/constants/declarations.ts
11
+ var NgDocDeclarations = [
12
+ "Class",
13
+ "Interface",
14
+ "Enum",
15
+ "Function",
16
+ "TypeAlias",
17
+ "Variable"
18
+ ];
19
+
20
+ // apps/ng-doc/docs/develop/apps/ng-doc/docs/develop/ng-doc.page.ts
21
+ var DevelopPage = {
22
+ title: "Develop",
23
+ mdFile: "./index.md.nunj",
24
+ onlyForTags: ["development"],
25
+ data: {
26
+ modifiers: ["abstract", "static", "async", "readonly"],
27
+ entities: {
28
+ typescript: NgDocDeclarations,
29
+ angular: NgDocAngularEntities
30
+ }
31
+ }
32
+ };
33
+ var ng_doc_page_default = DevelopPage;
34
+ export {
35
+ ng_doc_page_default as default
36
+ };
@@ -0,0 +1,19 @@
1
+ // apps/ng-doc/docs/getting-started/ng-doc.category.ts
2
+ var GettingStartedCategory = {
3
+ title: "Getting Started",
4
+ order: 1,
5
+ expandable: true
6
+ };
7
+ var ng_doc_category_default = GettingStartedCategory;
8
+
9
+ // apps/ng-doc/docs/getting-started/configuration/apps/ng-doc/docs/getting-started/configuration/ng-doc.page.ts
10
+ var Configuration = {
11
+ title: `Configuration`,
12
+ mdFile: "./index.md",
13
+ category: ng_doc_category_default,
14
+ order: 3
15
+ };
16
+ var ng_doc_page_default = Configuration;
17
+ export {
18
+ ng_doc_page_default as default
19
+ };
@@ -0,0 +1,19 @@
1
+ // apps/ng-doc/docs/getting-started/ng-doc.category.ts
2
+ var GettingStartedCategory = {
3
+ title: "Getting Started",
4
+ order: 1,
5
+ expandable: true
6
+ };
7
+ var ng_doc_category_default = GettingStartedCategory;
8
+
9
+ // apps/ng-doc/docs/getting-started/installation/apps/ng-doc/docs/getting-started/installation/ng-doc.page.ts
10
+ var page = {
11
+ title: `Installation`,
12
+ mdFile: ["./automatic.md", "manual.md"],
13
+ category: ng_doc_category_default,
14
+ order: 2
15
+ };
16
+ var ng_doc_page_default = page;
17
+ export {
18
+ ng_doc_page_default as default
19
+ };
@@ -0,0 +1,18 @@
1
+ // apps/ng-doc/docs/getting-started/ng-doc.category.ts
2
+ var GettingStartedCategory = {
3
+ title: "Getting Started",
4
+ order: 1,
5
+ expandable: true
6
+ };
7
+ var ng_doc_category_default = GettingStartedCategory;
8
+
9
+ // apps/ng-doc/docs/getting-started/migrations/apps/ng-doc/docs/getting-started/migrations/ng-doc.page.ts
10
+ var MigrationsPage = {
11
+ title: `Migrations`,
12
+ mdFile: "./index.md",
13
+ category: ng_doc_category_default
14
+ };
15
+ var ng_doc_page_default = MigrationsPage;
16
+ export {
17
+ ng_doc_page_default as default
18
+ };
@@ -0,0 +1,19 @@
1
+ // apps/ng-doc/docs/getting-started/ng-doc.category.ts
2
+ var GettingStartedCategory = {
3
+ title: "Getting Started",
4
+ order: 1,
5
+ expandable: true
6
+ };
7
+ var ng_doc_category_default = GettingStartedCategory;
8
+
9
+ // apps/ng-doc/docs/getting-started/ssr/apps/ng-doc/docs/getting-started/ssr/ng-doc.page.ts
10
+ var page = {
11
+ title: `SSR`,
12
+ mdFile: "./index.md",
13
+ category: ng_doc_category_default,
14
+ order: 3
15
+ };
16
+ var ng_doc_page_default = page;
17
+ export {
18
+ ng_doc_page_default as default
19
+ };
@@ -0,0 +1,19 @@
1
+ // apps/ng-doc/docs/getting-started/ng-doc.category.ts
2
+ var GettingStartedCategory = {
3
+ title: "Getting Started",
4
+ order: 1,
5
+ expandable: true
6
+ };
7
+ var ng_doc_category_default = GettingStartedCategory;
8
+
9
+ // apps/ng-doc/docs/getting-started/what-is-ng-doc/apps/ng-doc/docs/getting-started/what-is-ng-doc/ng-doc.page.ts
10
+ var page = {
11
+ title: `What is NgDoc?`,
12
+ mdFile: "./index.md",
13
+ category: ng_doc_category_default,
14
+ order: 1
15
+ };
16
+ var ng_doc_page_default = page;
17
+ export {
18
+ ng_doc_page_default as default
19
+ };
@@ -0,0 +1,42 @@
1
+ // apps/ng-doc/docs/apps/ng-doc/docs/ng-doc.api.ts
2
+ var api = {
3
+ title: "API References",
4
+ keyword: "ApiReferences",
5
+ scopes: [
6
+ {
7
+ name: "@ng-doc/app",
8
+ route: "app",
9
+ include: "libs/app/**/*.ts"
10
+ },
11
+ {
12
+ name: "@ng-doc/builder",
13
+ route: "builder",
14
+ include: [
15
+ "libs/builder/interfaces/**.ts",
16
+ "libs/builder/engine/**/*.ts",
17
+ "libs/builder/types/**.ts",
18
+ "libs/builder/schematics/**/*.ts"
19
+ ],
20
+ exclude: ["libs/builder/**/**.spec.ts"]
21
+ },
22
+ {
23
+ name: "@ng-doc/ui-kit",
24
+ route: "ui-kit",
25
+ include: "libs/ui-kit/**/*.ts"
26
+ },
27
+ {
28
+ name: "@ng-doc/core",
29
+ route: "core",
30
+ include: "libs/core/**/*.ts"
31
+ },
32
+ {
33
+ name: "@ng-doc/keywords-loaders",
34
+ route: "keywords-loaders",
35
+ include: "libs/keywords-loaders/index.ts"
36
+ }
37
+ ]
38
+ };
39
+ var ng_doc_api_default = api;
40
+ export {
41
+ ng_doc_api_default as default
42
+ };
@@ -0,0 +1,18 @@
1
+ // apps/ng-doc/docs/recipes/ng-doc.category.ts
2
+ var RecipesCategory = {
3
+ title: "Recipes",
4
+ expandable: true,
5
+ order: 7
6
+ };
7
+ var ng_doc_category_default = RecipesCategory;
8
+
9
+ // apps/ng-doc/docs/recipes/ignoring-file-lines/apps/ng-doc/docs/recipes/ignoring-file-lines/ng-doc.page.ts
10
+ var IgnoringFileLinesPage = {
11
+ title: `Ignoring file lines`,
12
+ mdFile: "./index.md",
13
+ category: ng_doc_category_default
14
+ };
15
+ var ng_doc_page_default = IgnoringFileLinesPage;
16
+ export {
17
+ ng_doc_page_default as default
18
+ };
@@ -0,0 +1,19 @@
1
+ // apps/ng-doc/docs/recipes/ng-doc.category.ts
2
+ var RecipesCategory = {
3
+ title: "Recipes",
4
+ expandable: true,
5
+ order: 7
6
+ };
7
+ var ng_doc_category_default = RecipesCategory;
8
+
9
+ // apps/ng-doc/docs/recipes/performance/apps/ng-doc/docs/recipes/performance/ng-doc.page.ts
10
+ var PerformancePage = {
11
+ title: `Performance`,
12
+ mdFile: "./index.md",
13
+ category: ng_doc_category_default,
14
+ order: 3
15
+ };
16
+ var ng_doc_page_default = PerformancePage;
17
+ export {
18
+ ng_doc_page_default as default
19
+ };
@@ -0,0 +1,18 @@
1
+ // apps/ng-doc/docs/writing-content/ng-doc.category.ts
2
+ var WritingContentCategory = {
3
+ title: "Writing content",
4
+ order: 2
5
+ };
6
+ var ng_doc_category_default = WritingContentCategory;
7
+
8
+ // apps/ng-doc/docs/writing-content/blockquotes/apps/ng-doc/docs/writing-content/blockquotes/ng-doc.page.ts
9
+ var BlockquotesPage = {
10
+ title: `Blockquotes`,
11
+ mdFile: "./index.md",
12
+ category: ng_doc_category_default,
13
+ order: 2
14
+ };
15
+ var ng_doc_page_default = BlockquotesPage;
16
+ export {
17
+ ng_doc_page_default as default
18
+ };
@@ -0,0 +1,18 @@
1
+ // apps/ng-doc/docs/writing-content/ng-doc.category.ts
2
+ var WritingContentCategory = {
3
+ title: "Writing content",
4
+ order: 2
5
+ };
6
+ var ng_doc_category_default = WritingContentCategory;
7
+
8
+ // apps/ng-doc/docs/writing-content/code-blocks/apps/ng-doc/docs/writing-content/code-blocks/ng-doc.page.ts
9
+ var CodeBlocksPage = {
10
+ title: `Code blocks`,
11
+ mdFile: "./index.md",
12
+ category: ng_doc_category_default,
13
+ order: 4
14
+ };
15
+ var ng_doc_page_default = CodeBlocksPage;
16
+ export {
17
+ ng_doc_page_default as default
18
+ };
@@ -0,0 +1,19 @@
1
+ // apps/ng-doc/docs/writing-content/ng-doc.category.ts
2
+ var WritingContentCategory = {
3
+ title: "Writing content",
4
+ order: 2
5
+ };
6
+ var ng_doc_category_default = WritingContentCategory;
7
+
8
+ // apps/ng-doc/docs/writing-content/demo-and-demo-pane/apps/ng-doc/docs/writing-content/demo-and-demo-pane/ng-doc.page.ts
9
+ var DemoAndDemoPanePage = {
10
+ title: "Demo and Demo Pane",
11
+ mdFile: ["./index.md", "./demo.md", "./demo-pane.md", "./snippets.md"],
12
+ category: ng_doc_category_default,
13
+ order: 7,
14
+ route: {}
15
+ };
16
+ var ng_doc_page_default = DemoAndDemoPanePage;
17
+ export {
18
+ ng_doc_page_default as default
19
+ };
@@ -0,0 +1,18 @@
1
+ // apps/ng-doc/docs/writing-content/ng-doc.category.ts
2
+ var WritingContentCategory = {
3
+ title: "Writing content",
4
+ order: 2
5
+ };
6
+ var ng_doc_category_default = WritingContentCategory;
7
+
8
+ // apps/ng-doc/docs/writing-content/images-videos-and-embeds/apps/ng-doc/docs/writing-content/images-videos-and-embeds/ng-doc.page.ts
9
+ var ImagesVideosAndEmbeds = {
10
+ title: `Images and embeds`,
11
+ mdFile: "./index.md",
12
+ category: ng_doc_category_default,
13
+ order: 3
14
+ };
15
+ var ng_doc_page_default = ImagesVideosAndEmbeds;
16
+ export {
17
+ ng_doc_page_default as default
18
+ };
@@ -0,0 +1,17 @@
1
+ // apps/ng-doc/docs/writing-content/ng-doc.category.ts
2
+ var WritingContentCategory = {
3
+ title: "Writing content",
4
+ order: 2
5
+ };
6
+ var ng_doc_category_default = WritingContentCategory;
7
+
8
+ // apps/ng-doc/docs/writing-content/keywords/apps/ng-doc/docs/writing-content/keywords/ng-doc.page.ts
9
+ var KeywordsPage = {
10
+ title: "Keywords",
11
+ mdFile: ["./index.md", "./loaders.md"],
12
+ category: ng_doc_category_default
13
+ };
14
+ var ng_doc_page_default = KeywordsPage;
15
+ export {
16
+ ng_doc_page_default as default
17
+ };
@@ -0,0 +1,18 @@
1
+ // apps/ng-doc/docs/writing-content/ng-doc.category.ts
2
+ var WritingContentCategory = {
3
+ title: "Writing content",
4
+ order: 2
5
+ };
6
+ var ng_doc_category_default = WritingContentCategory;
7
+
8
+ // apps/ng-doc/docs/writing-content/mermaid-diagrams/apps/ng-doc/docs/writing-content/mermaid-diagrams/ng-doc.page.ts
9
+ var MermaidDiagramsPage = {
10
+ title: `Mermaid diagrams`,
11
+ mdFile: "./index.md",
12
+ category: ng_doc_category_default,
13
+ order: 5
14
+ };
15
+ var ng_doc_page_default = MermaidDiagramsPage;
16
+ export {
17
+ ng_doc_page_default as default
18
+ };
@@ -0,0 +1,18 @@
1
+ // apps/ng-doc/docs/writing-content/ng-doc.category.ts
2
+ var WritingContentCategory = {
3
+ title: "Writing content",
4
+ order: 2
5
+ };
6
+ var ng_doc_category_default = WritingContentCategory;
7
+
8
+ // apps/ng-doc/docs/writing-content/nunjucks/apps/ng-doc/docs/writing-content/nunjucks/ng-doc.page.ts
9
+ var NunjucksPage = {
10
+ title: `Nunjucks`,
11
+ mdFile: "./index.md",
12
+ category: ng_doc_category_default,
13
+ order: 6
14
+ };
15
+ var ng_doc_page_default = NunjucksPage;
16
+ export {
17
+ ng_doc_page_default as default
18
+ };
@@ -0,0 +1,18 @@
1
+ // apps/ng-doc/docs/writing-content/ng-doc.category.ts
2
+ var WritingContentCategory = {
3
+ title: "Writing content",
4
+ order: 2
5
+ };
6
+ var ng_doc_category_default = WritingContentCategory;
7
+
8
+ // apps/ng-doc/docs/writing-content/pages-and-categories/apps/ng-doc/docs/writing-content/pages-and-categories/ng-doc.page.ts
9
+ var PagesAndCategoriesPage = {
10
+ title: `Pages and categories`,
11
+ mdFile: "./index.md",
12
+ category: ng_doc_category_default,
13
+ order: 1
14
+ };
15
+ var ng_doc_page_default = PagesAndCategoriesPage;
16
+ export {
17
+ ng_doc_page_default as default
18
+ };
@@ -0,0 +1,33 @@
1
+ // apps/ng-doc/docs/writing-content/ng-doc.category.ts
2
+ var WritingContentCategory = {
3
+ title: "Writing content",
4
+ order: 2
5
+ };
6
+ var ng_doc_category_default = WritingContentCategory;
7
+
8
+ // apps/ng-doc/docs/writing-content/playground/apps/ng-doc/docs/writing-content/playground/ng-doc.page.ts
9
+ var PlaygroundPage = {
10
+ title: `Playground`,
11
+ mdFile: ["./index.md", "./type-controls.md"],
12
+ category: ng_doc_category_default,
13
+ order: 8,
14
+ playgrounds: {
15
+ TagPlayground: {},
16
+ TagIconPlayground: {},
17
+ TagDataPlayground: {
18
+ data: {
19
+ array: [1, 2, 3]
20
+ }
21
+ },
22
+ RotatorPlayground: {},
23
+ DatePipePlayground: {},
24
+ ButtonPlayground: {
25
+ data: { label: "Button" }
26
+ },
27
+ FloatingCircle: {}
28
+ }
29
+ };
30
+ var ng_doc_page_default = PlaygroundPage;
31
+ export {
32
+ ng_doc_page_default as default
33
+ };
@@ -24,6 +24,8 @@ function apiAction(declarationPath) {
24
24
  hideDescription: true,
25
25
  hideSeeAlso: true,
26
26
  hideUsageNotes: true,
27
+ hideRemarks: true,
28
+ hideExamples: true,
27
29
  },
28
30
  });
29
31
  return {
@@ -1 +1 @@
1
- {"version":3,"file":"api.action.js","sourceRoot":"","sources":["../../../../../../libs/builder/engine/nunjucks/actions/api.action.ts"],"names":[],"mappings":";;AAWA,8BAyBC;AApCD,uCAAyC;AACzC,uCAAgC;AAEhC,8CAAoE;AACpE,0CAAgD;AAGhD;;;GAGG;AACH,SAAgB,SAAS,CAAC,eAAuB;IAC/C,OAAO,CAAC,KAAK,EAAE,EAAE;QACf,MAAM,OAAO,GAAG,KAAK,CAAC,UAAU,CAAC,UAAU,EAAE,CAAC;QAC9C,MAAM,WAAW,GAAG,IAAA,8BAAoB,EAAC,OAAO,EAAE,eAAe,CAAC,CAAC;QACnE,MAAM,eAAe,GAAG,WAAW,CAAC,OAAO,EAAE,IAAI,WAAW,CAAC;QAC7D,MAAM,QAAQ,GAAG,IAAA,gBAAS,EAAC,WAAW,CAAC,WAAW,EAAE,CAAC,CAAC;QACtD,MAAM,MAAM,GAAG,IAAA,sBAAc,EAAC,SAAS,QAAQ,YAAY,EAAE;YAC3D,OAAO,EAAE;gBACP,WAAW;gBACX,OAAO,EAAE,eAAI,CAAC,qBAAqB,CAAC,WAAW,CAAC;oBAC9C,CAAC,CAAC,WAAW,CAAC,oBAAoB,EAAE;oBACpC,CAAC,CAAC,WAAW;gBACf,eAAe,EAAE,IAAI;gBACrB,WAAW,EAAE,IAAI;gBACjB,cAAc,EAAE,IAAI;aACrB;SACF,CAAC,CAAC;QAEH,OAAO;YACL,MAAM,EAAE,IAAA,oBAAU,EAChB,6BAA6B,eAAe,YAAY,eAAe,KAAK,MAAM,yBAAyB,CAC5G;YACD,YAAY,EAAE,CAAC,WAAW,CAAC,aAAa,EAAE,CAAC,WAAW,EAAE,CAAC;SAC1D,CAAC;IACJ,CAAC,CAAC;AACJ,CAAC"}
1
+ {"version":3,"file":"api.action.js","sourceRoot":"","sources":["../../../../../../libs/builder/engine/nunjucks/actions/api.action.ts"],"names":[],"mappings":";;AAWA,8BA2BC;AAtCD,uCAAyC;AACzC,uCAAgC;AAEhC,8CAAoE;AACpE,0CAAgD;AAGhD;;;GAGG;AACH,SAAgB,SAAS,CAAC,eAAuB;IAC/C,OAAO,CAAC,KAAK,EAAE,EAAE;QACf,MAAM,OAAO,GAAG,KAAK,CAAC,UAAU,CAAC,UAAU,EAAE,CAAC;QAC9C,MAAM,WAAW,GAAG,IAAA,8BAAoB,EAAC,OAAO,EAAE,eAAe,CAAC,CAAC;QACnE,MAAM,eAAe,GAAG,WAAW,CAAC,OAAO,EAAE,IAAI,WAAW,CAAC;QAC7D,MAAM,QAAQ,GAAG,IAAA,gBAAS,EAAC,WAAW,CAAC,WAAW,EAAE,CAAC,CAAC;QACtD,MAAM,MAAM,GAAG,IAAA,sBAAc,EAAC,SAAS,QAAQ,YAAY,EAAE;YAC3D,OAAO,EAAE;gBACP,WAAW;gBACX,OAAO,EAAE,eAAI,CAAC,qBAAqB,CAAC,WAAW,CAAC;oBAC9C,CAAC,CAAC,WAAW,CAAC,oBAAoB,EAAE;oBACpC,CAAC,CAAC,WAAW;gBACf,eAAe,EAAE,IAAI;gBACrB,WAAW,EAAE,IAAI;gBACjB,cAAc,EAAE,IAAI;gBACpB,WAAW,EAAE,IAAI;gBACjB,YAAY,EAAE,IAAI;aACnB;SACF,CAAC,CAAC;QAEH,OAAO;YACL,MAAM,EAAE,IAAA,oBAAU,EAChB,6BAA6B,eAAe,YAAY,eAAe,KAAK,MAAM,yBAAyB,CAC5G;YACD,YAAY,EAAE,CAAC,WAAW,CAAC,aAAa,EAAE,CAAC,WAAW,EAAE,CAAC;SAC1D,CAAC;IACJ,CAAC,CAAC;AACJ,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@ng-doc/builder",
3
- "version": "18.1.1",
3
+ "version": "18.2.0",
4
4
  "type": "commonjs",
5
5
  "builders": "./builders.json",
6
6
  "schematics": "./schematics/collection.json",
@@ -11,8 +11,8 @@
11
11
  ]
12
12
  },
13
13
  "dependencies": {
14
- "@ng-doc/core": "18.1.1",
15
- "@ng-doc/utils": "18.1.1",
14
+ "@ng-doc/core": "18.2.0",
15
+ "@ng-doc/utils": "18.2.0",
16
16
  "@angular-devkit/architect": ">=0.1801.0",
17
17
  "@angular-devkit/build-angular": ">=18.1.0",
18
18
  "chokidar": "3.5.3",
@@ -35,7 +35,7 @@
35
35
  "tslib": "^2.6.2",
36
36
  "ng-morph": "4.0.3",
37
37
  "parsimmon": "^1.18.1",
38
- "@parcel/watcher": "2.3.0"
38
+ "@parcel/watcher": "2.4.1"
39
39
  },
40
40
  "publishConfig": {
41
41
  "access": "public"
@@ -7,12 +7,20 @@
7
7
  {{ description if description else noContentMacro.render('No documentation has been provided.') }}
8
8
  {% endif %}
9
9
 
10
+ {% if not hideRemarks %}
11
+ {% include "parts/remarks.html.nunj" %}
12
+ {% endif %}
13
+
10
14
  {% if not hideSeeAlso %}
11
15
  {% include "parts/see-also.html.nunj" %}
12
16
  {% endif %}
13
17
 
14
18
  {% block overview %}{% endblock %}
15
19
 
20
+ {% if not hideExamples %}
21
+ {% include "parts/examples.html.nunj" %}
22
+ {% endif %}
23
+
16
24
  {% if not hideUsageNotes %}
17
25
  {% include "parts/usage-notes.html.nunj" %}
18
26
  {% endif %}
@@ -1,16 +1,27 @@
1
1
  {% extends "api/base.html.nunj" %}
2
2
 
3
3
  {% import "helpers/code.html.nunj" as codeMacro %}
4
+ {% import "helpers/type.html.nunj" as typeMacro %}
4
5
  {% import "helpers/parameters.html.nunj" as parametersMacro %}
5
6
  {% import "helpers/overload.html.nunj" as overloadMacro %}
6
7
 
7
8
  {% block overview %}
8
9
  {%- set parameters = declaration.getParameters() -%}
9
10
  {%- set overloads = declaration.getOverloads() -%}
11
+ {%- set returnsTag = docNode | getJsDocTag('returns') -%}
10
12
 
11
13
  <h2>Presentation</h2>
12
14
  {{ codeMacro.render(declaration | functionPresentation, "typescript", false) }}
13
15
 
16
+ <h2>Returns</h2>
17
+ <div class="ng-doc-returns">
18
+ {{ typeMacro.returnType(declaration) }}
19
+ {%- if returnsTag.length %}
20
+ <span> - </span>
21
+ {{ returnsTag | markdownToHtml }}
22
+ {%- endif %}
23
+ </div>
24
+
14
25
  {% if parameters.length -%}
15
26
  <h2>Parameters</h2>
16
27
  {{ parametersMacro.render(parameters, declaration) }}
@@ -48,6 +48,8 @@
48
48
  {% set description = docNode | getJsDocDescription %}
49
49
 
50
50
  {{ description if description else noContentMacro.render('No documentation has been provided.') }}
51
+
52
+ {% include "parts/member-remarks.html.nunj" %}
51
53
  </td>
52
54
  </tr>
53
55
  <tr>
@@ -15,6 +15,7 @@
15
15
  {% set implementedMember = method | getImplementedMember %}
16
16
  {% set docNode = methodChain | firstNodeWithComment %}
17
17
  {% set overloads = method.getOverloads() if method.getOverloads else [] %}
18
+ {% set returnsTag = docNode | getJsDocTag('returns') %}
18
19
 
19
20
  <table class="{{ statusMacro.class(method) }}">
20
21
  <thead>
@@ -46,6 +47,8 @@
46
47
  {% set description = docNode | getJsDocDescription %}
47
48
 
48
49
  {{ description if description else noContentMacro.render('No documentation has been provided.') }}
50
+
51
+ {% include "parts/member-remarks.html.nunj" %}
49
52
  </td>
50
53
  </tr>
51
54
  <tr>
@@ -61,12 +64,19 @@
61
64
  {{ parametersMacro.render(parameters, docNode) }}
62
65
  {%- endif %}
63
66
  <h5 class="no-anchor ng-doc-secondary-heading" indexable="false">Returns</h5>
64
- <p>
67
+
68
+ <div class="ng-doc-returns">
65
69
  {{ typeMacro.returnType(method) }}
66
- </p>
70
+ {%- if returnsTag.length %}
71
+ <span> - </span>
72
+ {{ returnsTag | markdownToHtml }}
73
+ {%- endif %}
74
+ </div>
67
75
  </td>
68
76
  </tr>
69
77
 
78
+ {% include "parts/member-examples.html.nunj" %}
79
+
70
80
  {% if overloads.length %}
71
81
  <tr>
72
82
  <td>
@@ -7,6 +7,7 @@
7
7
  {% for overload in overloads %}
8
8
  {% set docNode = overload %}
9
9
  {% set parameters = overload.getParameters() %}
10
+ {% set returnsTag = docNode | getJsDocTag('returns') %}
10
11
 
11
12
  <table class="ng-doc-overload-table">
12
13
  <thead indexable="false">
@@ -20,6 +21,8 @@
20
21
  {% set description = docNode | getJsDocDescription %}
21
22
 
22
23
  {{ description if description else noContentMacro.render('No documentation has been provided.') }}
24
+
25
+ {% include "parts/member-remarks.html.nunj" %}
23
26
  </td>
24
27
  </tr>
25
28
  <tr>
@@ -35,11 +38,18 @@
35
38
  {{ parametersMacro.render(parameters, docNode) }}
36
39
  {%- endif %}
37
40
  <h5 class="no-anchor" indexable="false">Returns</h5>
38
- <p>
41
+ <div class="ng-doc-returns">
39
42
  {{ typeMacro.returnType(overload) }}
40
- </p>
43
+ {%- if returnsTag.length %}
44
+ <span> - </span>
45
+ {{ returnsTag | markdownToHtml }}
46
+ {%- endif %}
47
+ </div>
41
48
  </td>
42
49
  </tr>
50
+
51
+ {% include "parts/member-examples.html.nunj" %}
52
+
43
53
  </tbody>
44
54
  </table>
45
55
  {% endfor %}
@@ -2,6 +2,7 @@
2
2
  {% import "helpers/declaration-modifiers.html.nunj" as tagsMacro %}
3
3
  {% import "helpers/decorators.html.nunj" as decoratorsMacro %}
4
4
  {% import "helpers/status.html.nunj" as statusMacro %}
5
+ {% set examplesColSpan = 3 %}
5
6
 
6
7
  {% macro render(properties, origin) %}
7
8
  <table class="ng-doc-api-table sticky first-colum-highlighted">
@@ -42,8 +43,13 @@
42
43
  {{ statusMacro.render(property) }}
43
44
  </div>
44
45
  {{ docNode | getJsDocDescription }}
46
+
47
+ {% include "parts/member-remarks.html.nunj" %}
45
48
  </td>
46
49
  </tr>
50
+
51
+ {% include "parts/member-examples.html.nunj" %}
52
+
47
53
  {%- endfor %}
48
54
  </tbody>
49
55
  </table>
@@ -30,7 +30,7 @@ const routes: Routes = [{
30
30
  {
31
31
  path: '{{ entry.route }}',
32
32
  loadChildren: () => import('./{{ importPath }}'),
33
- title: '{{ entry.title | toTemplateString }}',
33
+ title: `{{ entry.title | toTemplateString }}`,
34
34
  data: {
35
35
  icon: '{{ entry.entry.icon }}',
36
36
  }
@@ -0,0 +1,11 @@
1
+ {%- set examples = docNode | getJsDocTags('example') -%}
2
+
3
+ {% if examples.length -%}
4
+ <section indexable="false">
5
+ <h2>Example usage</h2>
6
+
7
+ {% for example in examples -%}
8
+ {{ example }}
9
+ {%- endfor %}
10
+ </section>
11
+ {%- endif %}
@@ -0,0 +1,12 @@
1
+ {%- set examples = docNode | getJsDocTags('example') -%}
2
+
3
+ {% if examples.length -%}
4
+ <tr indexable="false">
5
+ <td {% if examplesColSpan %}colspan="{{ examplesColSpan }}"{% endif %}>
6
+ <h5 class="no-anchor ng-doc-secondary-heading" indexable="false">Example usage</h5>
7
+ {% for example in examples -%}
8
+ {{ example }}
9
+ {%- endfor %}
10
+ </td>
11
+ </tr>
12
+ {%- endif %}
@@ -0,0 +1,8 @@
1
+ {%- set remarks = docNode | getJsDocTags('remarks') -%}
2
+
3
+ {% if remarks.length %}
4
+ <h5 class="no-anchor ng-doc-secondary-heading" indexable="false">Notes</h5>
5
+ {%- for remark in remarks %}
6
+ {{ remark | markdownToHtml }}
7
+ {%- endfor %}
8
+ {% endif %}
@@ -0,0 +1,10 @@
1
+ {%- set remarks = docNode | getJsDocTags('remarks') -%}
2
+
3
+ {% if remarks.length %}
4
+ <h2>Notes</h2>
5
+ <section>
6
+ {%- for remark in remarks %}
7
+ {{ remark | markdownToHtml }}
8
+ {%- endfor %}
9
+ </section>
10
+ {% endif %}