4.40.0 • Published 1 month ago

@taiga-ui/addon-doc v4.40.0

Weekly downloads
122
License
Apache-2.0
Repository
github
Last release
1 month ago

Taiga UI — Doc

npm version npm bundle size Discord

Taiga UI based library for developing documentation portals for Angular libraries.

How to install

Install main packages:

npm i @taiga-ui/{cdk,core,kit,addon-mobile}

Install doc:

npm i @taiga-ui/addon-doc

How to use

You can also see community made guide in Russian

  1. Include TuiDocMainModule in your App module and use in your template:

    <tui-doc-main>You can add content here, it will be shown below navigation in the sidebar</tui-doc-main>
  2. Configure languages to highlight in your main module:

    import {Component} from '@angular/core';
    import {TuiDocMainModule} from '@taiga-ui/addon-doc';
    import {hljsLanguages} from './hljsLanguages';
    import {HIGHLIGHT_OPTIONS, HighlightLanguage} from 'ngx-highlightjs';
    import {App} from './app.component';
    
    @Component({
      standalone: true,
      imports: [TuiDocMainModule],
      providers: [
        {
          provide: HIGHLIGHT_OPTIONS,
          useValue: {
            coreLibraryLoader: () => import('highlight.js/lib/core' as string),
            lineNumbersLoader: () => import('highlightjs-line-numbers.js' as string), // Optional, only if you want the line numbers
            languages: {
              typescript: () => import('highlight.js/lib/languages/typescript' as string),
              less: () => import('highlight.js/lib/languages/less' as string),
              xml: () => import('highlight.js/lib/languages/xml' as string),
            },
          },
        },
      ],
    })
    export class App {}
  3. Configure documentation providers:

    TUI_DOC_PAGES — an array of pages, see TuiDocPages type

    TUI_DOC_LOGO — an src for the SVG logo in the sidebar

    TUI_DOC_DEFAULT_TABS — an array of default named for tabs on your typical page

    TUI_DOC_TITLE — a title prefix for the browser tab

    TUI_DOC_SEE_ALSO — a two dimensional array of related pages by their titles

    TUI_DOC_SEARCH_ENABLED — enable doc search. Default value is true

  4. Configure routing:

    import {Routes} from '@angular/router';
    
    const appRoutes: Routes = [
      {
        path: 'super-page',
        loadChildren: async () => (await import('../super-page/super-page.module')).SuperModule,
        data: {
          title: 'Super Page',
        },
      },
      // ...
    ];

    You must have title in route data in order for TUI_DOC_SEE_ALSO to work. It would also be automatically added to TUI_DOC_TITLE for browser tab title when navigating to that route.

  5. Create pages.

    Module:

    import {TuiAddonDoc} from '@taiga-ui/addon-doc';
    
    @Component({
      standalone: true,
      imports: [TuiAddonDoc, SuperComponent],
    })
    export class App {}

    Component:

    // ..
    
    @Component({
      standalone: true,
      selector: 'super',
      templateUrl: './super.component.html',
    })
    export class Super {
      // Keys would be used as tabs for code example
      readonly example = {
        // import a file as a string
        TypeScript: import('./examples/1/index.ts?raw'),
        HTML: import('./examples/1/index.html?raw'),
      };
    
      readonly inputVariants = ['input 1', 'input 2'];
    }

    You can use any tool to import a file as a string. For example, you can use Webpack Asset Modules.

    Template:

    <tui-doc-page
      header="Super"
      package="SUPER-PACKAGE"
      deprecated
    >
      <ng-template pageTab>
        <!-- default tab name would be used -->
        This would be the content of a first tab
    
        <tui-doc-example
          id="basic-example"
          heading="Example of usage"
          [content]="example"
        >
          <example-1></example-1>
        </tui-doc-example>
      </ng-template>
    
      <ng-template pageTab="Documentation">
        <tui-doc-demo>
          <super-component [input]="input"></super-component>
        </tui-doc-demo>
        <tui-doc-documentation>
          <ng-template
            documentationPropertyName="input"
            documentationPropertyMode="input"
            documentationPropertyType="T"
            [documentationPropertyValues]="inputVariants"
            [(documentationPropertyValue)]="input"
          >
            Some input
          </ng-template>
        </tui-doc-documentation>
      </ng-template>
    </tui-doc-page>
4.37.0

2 months ago

4.39.1

2 months ago

4.39.0

2 months ago

4.39.2

2 months ago

3.108.0

4 months ago

4.33.0

3 months ago

3.113.0

3 months ago

4.35.0

3 months ago

3.115.0

2 months ago

4.40.0

1 month ago

4.31.0

4 months ago

3.111.0

3 months ago

3.109.0

4 months ago

4.29.0

4 months ago

3.116.0

2 months ago

4.36.0

2 months ago

4.38.0

2 months ago

3.112.0

3 months ago

4.32.0

3 months ago

3.114.0

3 months ago

4.34.0

3 months ago

3.110.0

4 months ago

4.30.0

4 months ago

4.28.0

4 months ago

3.107.0

4 months ago

3.106.0

4 months ago

4.27.0

4 months ago

4.27.1

4 months ago

4.26.0

5 months ago

4.26.1

5 months ago

4.25.0

5 months ago

3.105.0

5 months ago

3.104.1

5 months ago

4.24.0

5 months ago

3.104.0

5 months ago

4.23.0

5 months ago

4.22.0

6 months ago

3.103.0

6 months ago

4.21.0

6 months ago

3.102.1

6 months ago

4.20.0

6 months ago

3.102.0

6 months ago

4.14.0

8 months ago

3.97.0

8 months ago

4.16.0

8 months ago

4.15.0

8 months ago

3.100.0

7 months ago

3.101.0

7 months ago

4.18.0

7 months ago

4.17.0

8 months ago

3.98.0

8 months ago

4.19.0

7 months ago

3.99.0

8 months ago

4.13.0

9 months ago

3.96.0

9 months ago

4.12.0

9 months ago

4.11.0

9 months ago

3.95.2

9 months ago

3.95.1

10 months ago

4.10.0

9 months ago

4.9.0

10 months ago

3.95.0

10 months ago

4.8.1

10 months ago

4.8.0

10 months ago

3.85.0

1 year ago

4.0.1

11 months ago

4.0.0

11 months ago

3.86.0

1 year ago

4.0.0-rc.10

11 months ago

3.83.0

1 year ago

3.94.0

10 months ago

3.84.0

1 year ago

3.81.0

1 year ago

3.92.0

11 months ago

4.4.1

11 months ago

4.4.0

11 months ago

3.82.0

1 year ago

3.93.0

11 months ago

4.3.0

11 months ago

3.90.0

11 months ago

4.2.0

11 months ago

3.80.0

1 year ago

3.91.0

11 months ago

4.1.0

11 months ago

4.7.0

10 months ago

4.6.0

10 months ago

4.5.0

11 months ago

3.89.0

11 months ago

3.87.0

12 months ago

4.0.0-rc.9

11 months ago

4.0.0-rc.8

12 months ago

4.0.0-rc.1

1 year ago

4.0.0-rc.3

1 year ago

4.0.0-rc.2

1 year ago

4.0.0-rc.5

1 year ago

4.0.0-rc.4

1 year ago

4.0.0-rc.7

12 months ago

4.0.0-rc.6

12 months ago

3.88.0

12 months ago

3.79.0

1 year ago

3.78.0

1 year ago

3.77.1

1 year ago

3.77.0

1 year ago

3.76.0

1 year ago

3.75.0

1 year ago

3.74.0

1 year ago

3.73.0

1 year ago

3.72.0

1 year ago

3.71.0

1 year ago

3.70.0

1 year ago

3.69.0

1 year ago

3.68.0

1 year ago

3.67.0

1 year ago

3.66.0

1 year ago

3.65.0

1 year ago

3.64.0

1 year ago

3.63.0

1 year ago

3.62.0

1 year ago

3.61.0

2 years ago

3.60.0

2 years ago

3.59.0

2 years ago

3.58.0

2 years ago

3.56.0

2 years ago

3.57.0

2 years ago

3.50.0

2 years ago

3.40.0

2 years ago

3.51.0

2 years ago

2.99.0

2 years ago

2.98.0

2 years ago

2.97.0

2 years ago

3.38.0

2 years ago

3.49.0

2 years ago

3.49.1

2 years ago

2.96.0

2 years ago

3.39.0

2 years ago

3.39.1

2 years ago

2.95.0

2 years ago

3.36.0

2 years ago

3.36.1

2 years ago

3.36.2

2 years ago

3.35.0

2 years ago

3.47.0

2 years ago

2.94.1

2 years ago

2.94.0

2 years ago

3.37.0

2 years ago

3.48.0

2 years ago

3.45.0

2 years ago

3.46.0

2 years ago

3.43.0

2 years ago

3.54.0

2 years ago

3.44.0

2 years ago

3.44.1

2 years ago

3.55.0

2 years ago

3.41.0

2 years ago

3.41.1

2 years ago

3.52.0

2 years ago

3.42.0

2 years ago

3.42.1

2 years ago

3.53.0

2 years ago

3.34.0

2 years ago

3.33.1

2 years ago

2.93.0

2 years ago

3.33.0

2 years ago

2.89.0

2 years ago

2.92.0

2 years ago

2.91.0

2 years ago

3.31.0

2 years ago

3.31.1

2 years ago

2.90.0

2 years ago

3.32.0

2 years ago

3.30.0

2 years ago

2.88.0

2 years ago

2.87.0

2 years ago

3.28.0

2 years ago

3.29.1

2 years ago

3.29.0

2 years ago

3.29.2

2 years ago

3.26.0

2 years ago

3.27.0

2 years ago

3.24.0

2 years ago

2.83.0

2 years ago

2.79.0

2 years ago

2.82.0

2 years ago

3.25.0

2 years ago

3.22.0

2 years ago

2.81.0

2 years ago

3.23.1

2 years ago

3.23.0

2 years ago

2.80.0

2 years ago

3.20.0

2 years ago

3.21.0

2 years ago

2.86.0

2 years ago

2.85.0

2 years ago

2.84.0

2 years ago

2.78.0

2 years ago

3.19.0

2 years ago

2.77.0

2 years ago

3.18.0

2 years ago

2.76.0

2 years ago

3.17.0

2 years ago

2.72.0

3 years ago

3.12.1

3 years ago

3.12.0

3 years ago

2.71.0

3 years ago

2.75.0

2 years ago

3.14.0

3 years ago

3.13.0

3 years ago

2.74.0

3 years ago

3.15.0

3 years ago

2.70.0

3 years ago

2.73.0

3 years ago

3.16.0

2 years ago

2.69.0

3 years ago

3.6.0

3 years ago

2.64.0

3 years ago

2.68.0

3 years ago

3.5.0

3 years ago

2.67.0

3 years ago

3.9.0

3 years ago

3.8.0

3 years ago

3.10.0

3 years ago

2.66.0

3 years ago

2.66.1

3 years ago

3.11.0

3 years ago

3.7.1

3 years ago

3.7.0

3 years ago

2.65.0

3 years ago

3.2.0

3 years ago

3.1.0

3 years ago

2.63.0

3 years ago

3.4.0

3 years ago

3.0.1

3 years ago

3.0.0

3 years ago

2.62.2

3 years ago

2.62.3

3 years ago

2.62.4

3 years ago

2.62.0

3 years ago

2.62.1

3 years ago

3.3.0

3 years ago

3.0.0-rc.6

3 years ago

3.0.0-rc.5

3 years ago

3.0.0-rc.4

3 years ago

3.0.0-rc.2

3 years ago

3.0.0-rc.1

3 years ago

3.0.0-rc.3

3 years ago

2.61.0

3 years ago

2.53.0

3 years ago

2.57.0

3 years ago

2.60.0

3 years ago

2.49.1

3 years ago

2.49.2

3 years ago

2.49.0

3 years ago

2.56.0

3 years ago

2.52.0

3 years ago

2.55.0

3 years ago

2.51.0

3 years ago

2.51.1

3 years ago

2.59.0

3 years ago

2.59.1

3 years ago

2.54.0

3 years ago

2.54.1

3 years ago

2.50.0

3 years ago

2.50.1

3 years ago

2.50.2

3 years ago

3.0.0-rc.0

3 years ago

2.58.0

3 years ago

2.58.1

3 years ago

2.46.0

3 years ago

2.48.0

3 years ago

2.45.0

3 years ago

2.47.0

3 years ago

2.44.0

3 years ago

2.43.0

3 years ago

2.41.1

3 years ago

2.41.0

3 years ago

2.42.0

3 years ago

2.40.0

3 years ago

2.39.0

3 years ago

2.38.0

3 years ago

2.37.1

3 years ago

2.37.0

3 years ago

2.36.0

3 years ago

2.32.0

3 years ago

2.34.0

3 years ago

2.30.0

3 years ago

2.31.0

3 years ago

2.33.0

3 years ago

2.35.0

3 years ago

2.29.0

4 years ago

2.27.1

4 years ago

2.25.0

4 years ago

2.27.0

4 years ago

2.28.0

4 years ago

2.24.0

4 years ago

2.26.0

4 years ago

2.23.0

4 years ago

2.22.0

4 years ago

2.21.0

4 years ago

2.20.0

4 years ago

2.19.0

4 years ago

2.18.0

4 years ago

2.16.0-fixed.2

4 years ago

2.17.0

4 years ago

2.16.0-fixed

4 years ago

2.16.3

4 years ago

2.16.1

4 years ago

2.16.2

4 years ago

2.16.0

4 years ago

2.15.0

4 years ago

2.14.0

4 years ago

2.13.1

4 years ago

2.13.0

4 years ago

2.12.0

4 years ago

2.11.2

4 years ago

2.11.0

4 years ago

2.11.1

4 years ago

2.10.1

4 years ago

2.10.0

4 years ago

2.9.0

4 years ago

2.9.1

4 years ago

2.8.1

4 years ago

2.8.0

4 years ago

2.8.2

4 years ago

2.7.0

4 years ago

2.6.2

4 years ago

2.6.1

4 years ago

2.6.0

4 years ago

2.5.0

4 years ago

2.4.0

4 years ago

2.3.0

4 years ago

2.2.1

4 years ago

2.2.0

4 years ago

2.1.3

4 years ago

2.1.2

5 years ago

2.1.1

5 years ago

2.1.0

5 years ago

2.0.1

5 years ago

2.0.0

5 years ago

1.6.5

5 years ago

1.6.4

5 years ago

1.6.3

5 years ago

1.6.2

5 years ago

1.6.0

5 years ago