@taiga-ui/addon-doc 2.20.0 → 2.24.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 (63) hide show
  1. package/README.md +7 -19
  2. package/bundles/taiga-ui-addon-doc.umd.js +170 -95
  3. package/bundles/taiga-ui-addon-doc.umd.js.map +1 -1
  4. package/bundles/taiga-ui-addon-doc.umd.min.js +2 -2
  5. package/bundles/taiga-ui-addon-doc.umd.min.js.map +1 -1
  6. package/components/code/code.component.d.ts +4 -1
  7. package/components/documentation/documentation-property-connector.directive.d.ts +3 -1
  8. package/components/example/example-get-tabs.pipe.d.ts +4 -0
  9. package/components/example/example.component.d.ts +4 -7
  10. package/components/navigation/navigation.component.d.ts +2 -1
  11. package/esm2015/components/code/code.component.js +11 -4
  12. package/esm2015/components/copy/copy.component.js +2 -2
  13. package/esm2015/components/demo/demo.component.js +3 -3
  14. package/esm2015/components/documentation/documentation-property-connector.directive.js +9 -2
  15. package/esm2015/components/documentation/documentation.component.js +9 -3
  16. package/esm2015/components/documentation/documentation.module.js +3 -2
  17. package/esm2015/components/example/example-get-tabs.pipe.js +12 -0
  18. package/esm2015/components/example/example.component.js +9 -27
  19. package/esm2015/components/example/example.module.js +4 -3
  20. package/esm2015/components/main/main.component.js +4 -2
  21. package/esm2015/components/navigation/navigation.component.js +20 -17
  22. package/esm2015/components/page/page.component.js +3 -3
  23. package/esm2015/interfaces/page.js +1 -1
  24. package/esm2015/internal/header/header.component.js +12 -8
  25. package/esm2015/internal/see-also/see-also.component.js +2 -2
  26. package/esm2015/internal/source-code/source-code.component.js +1 -1
  27. package/esm2015/taiga-ui-addon-doc.js +9 -8
  28. package/esm2015/tokens/example-content-processor.js +2 -4
  29. package/esm2015/tokens/i18n.js +13 -5
  30. package/esm2015/utils/raw-load-record.js +12 -0
  31. package/esm2015/utils/raw-load.js +7 -0
  32. package/esm5/components/code/code.component.js +15 -4
  33. package/esm5/components/copy/copy.component.js +2 -2
  34. package/esm5/components/demo/demo.component.js +3 -3
  35. package/esm5/components/documentation/documentation-property-connector.directive.js +9 -2
  36. package/esm5/components/documentation/documentation.component.js +9 -3
  37. package/esm5/components/documentation/documentation.module.js +3 -2
  38. package/esm5/components/example/example-get-tabs.pipe.js +15 -0
  39. package/esm5/components/example/example.component.js +10 -44
  40. package/esm5/components/example/example.module.js +4 -3
  41. package/esm5/components/main/main.component.js +4 -2
  42. package/esm5/components/navigation/navigation.component.js +20 -17
  43. package/esm5/components/page/page.component.js +3 -3
  44. package/esm5/interfaces/page.js +1 -1
  45. package/esm5/internal/header/header.component.js +12 -8
  46. package/esm5/internal/see-also/see-also.component.js +2 -2
  47. package/esm5/internal/source-code/source-code.component.js +1 -1
  48. package/esm5/taiga-ui-addon-doc.js +9 -8
  49. package/esm5/tokens/example-content-processor.js +2 -4
  50. package/esm5/tokens/i18n.js +13 -5
  51. package/esm5/utils/raw-load-record.js +44 -0
  52. package/esm5/utils/raw-load.js +21 -0
  53. package/fesm2015/taiga-ui-addon-doc.js +111 -73
  54. package/fesm2015/taiga-ui-addon-doc.js.map +1 -1
  55. package/fesm5/taiga-ui-addon-doc.js +164 -89
  56. package/fesm5/taiga-ui-addon-doc.js.map +1 -1
  57. package/interfaces/page.d.ts +4 -0
  58. package/internal/header/header.component.d.ts +3 -1
  59. package/package.json +6 -6
  60. package/taiga-ui-addon-doc.d.ts +8 -7
  61. package/taiga-ui-addon-doc.metadata.json +1 -1
  62. package/utils/raw-load-record.d.ts +2 -0
  63. package/utils/raw-load.d.ts +2 -0
package/README.md CHANGED
@@ -27,9 +27,7 @@ npm i @taiga-ui/addon-doc
27
27
  1. Include `TuiDocMainModule` in your App module and use in your template:
28
28
 
29
29
  ```html
30
- <tui-doc-main>
31
- You can add content here, it will be shown below navigation in the sidebar
32
- </tui-doc-main>
30
+ <tui-doc-main>You can add content here, it will be shown below navigation in the sidebar</tui-doc-main>
33
31
  ```
34
32
 
35
33
  2. Configure languages to highlight in your main module:
@@ -50,11 +48,9 @@ npm i @taiga-ui/addon-doc
50
48
  provide: HIGHLIGHT_OPTIONS,
51
49
  useValue: {
52
50
  coreLibraryLoader: () => import('highlight.js/lib/core' as string),
53
- lineNumbersLoader: () =>
54
- import('highlightjs-line-numbers.js' as string), // Optional, only if you want the line numbers
51
+ lineNumbersLoader: () => import('highlightjs-line-numbers.js' as string), // Optional, only if you want the line numbers
55
52
  languages: {
56
- typescript: () =>
57
- import('highlight.js/lib/languages/typescript' as string),
53
+ typescript: () => import('highlight.js/lib/languages/typescript' as string),
58
54
  less: () => import('highlight.js/lib/languages/less' as string),
59
55
  xml: () => import('highlight.js/lib/languages/xml' as string),
60
56
  },
@@ -94,9 +90,8 @@ npm i @taiga-ui/addon-doc
94
90
  ];
95
91
  ```
96
92
 
97
- > You must have title in route data in order for `TUI_DOC_SEE_ALSO` to work.
98
- > It would also be automatically added to `TUI_DOC_TITLE` for browser tab title
99
- > when navigating to that route.
93
+ > You must have title in route data in order for `TUI_DOC_SEE_ALSO` to work. It would also be automatically added to
94
+ > `TUI_DOC_TITLE` for browser tab title when navigating to that route.
100
95
 
101
96
  5. Create pages.
102
97
 
@@ -109,10 +104,7 @@ npm i @taiga-ui/addon-doc
109
104
  import {SuperComponent} from './super.component';
110
105
 
111
106
  @NgModule({
112
- imports: [
113
- TuiAddonDocModule,
114
- RouterModule.forChild(generateRoutes(SuperComponent)),
115
- ],
107
+ imports: [TuiAddonDocModule, RouterModule.forChild(generateRoutes(SuperComponent))],
116
108
  declarations: [SuperComponent],
117
109
  exports: [SuperComponent],
118
110
  })
@@ -150,11 +142,7 @@ npm i @taiga-ui/addon-doc
150
142
  <!-- default tab name would be used -->
151
143
  This would be the content of a first tab
152
144
 
153
- <tui-doc-example
154
- id="basic-example"
155
- heading="Example of usage"
156
- [content]="example"
157
- >
145
+ <tui-doc-example id="basic-example" heading="Example of usage" [content]="example">
158
146
  <example-1></example-1>
159
147
  </tui-doc-example>
160
148
  </ng-template>