This public repository contains the documentation source for the Ignite UI for Angular, Ignite UI for Blazor, Ignite UI for React, and Ignite UI for Web Components products. They are built and hosted using Astro.
git clone https://github.com/IgniteUI/igniteui-documentation.git
cd igniteui-documentation
npm installigniteui-documentation/
├── docs/
│ ├── angular/ # Angular documentation package and generated Angular content
│ │ ├── public/ # Angular-specific static assets
│ │ ├── scripts/ # Angular sync and generation scripts
│ │ └── src/ # Angular Astro pages, MDX content, and components
│ └── xplat/ # Shared xplat source for Blazor, React, Web Components, and Angular-generated docs
│ ├── public/ # xplat static assets
│ ├── scripts/ # xplat generation scripts
│ └── src/ # xplat Astro pages, MDX content, assets, and libraries
├── public/ # Shared public assets
├── scripts/ # Repository-level utility scripts
├── src/ # Shared Astro framework, routing, sidebar, content helpers, styles, and integrations
├── package.json # Root workspace and convenience scripts
└── tsconfig.json # Root TypeScript configuration
The old template-level run commands are obsolete for product documentation. Each documentation package owns its run, build, and preview commands in its own package.json.
Use the platform-specific commands from the root workspace:
| Product | Dev command |
|---|---|
| Angular | npm run angular:dev |
| Angular English | npm run angular:dev:en |
| Angular Japanese | npm run angular:dev:jp |
| Angular Korean | npm run angular:dev:kr |
| React | npm run xplat:dev:react |
| React Japanese | npm run xplat:dev:react:jp |
| Web Components | npm run xplat:dev:webcomponents |
| Web Components Japanese | npm run xplat:dev:webcomponents:jp |
| Blazor | npm run xplat:dev:blazor |
| Blazor Japanese | npm run xplat:dev:blazor:jp |
The MDX files currently use these documentation components from igniteui-astro-components/components/mdx:
| Component | Purpose |
|---|---|
ApiLink |
Links to generated API reference entries. |
DocsAside |
Adds callouts and aside content inside documentation pages. |
PlatformBlock |
Shows content only for selected platforms. |
Sample |
Embeds runnable or linked product samples. |
Use the root check-mdx-links scripts to validate ApiLink references:
| Scope | Command |
|---|---|
| All MDX sources | npm run check-mdx-links |
| Angular docs | npm run check-mdx-links:angular |
| React xplat docs | npm run check-mdx-links:react |
| Web Components xplat docs | npm run check-mdx-links:wc |
| Blazor xplat docs | npm run check-mdx-links:blazor |
| Markdown reports | npm run check-mdx-links:report:<platform> |
| Resolve-only broken-link reports | npm run check-mdx-links:broken:<platform> |
These scripts also check for ambiguous ApiLink references. If a symbol exists in more than one registry package and the link does not specify enough information to choose safely, the script prints an Ambiguous ApiLinks section, writes an api-link-ambiguity-report*.md file under reports/, and exits with a failure.
Fix ambiguous links by adding a specific pkg or kind prop. If the correct target differs by platform, wrap platform-specific links in PlatformBlock.
- Angular content lives under
docs/angular/src/content/<locale>/. - Shared xplat content lives under
docs/xplat/src/content/<locale>/. - Static images and assets are stored in the nearest product package when product-specific, or in the root
public/directory when shared.
- .github/CONTRIBUTING.md: day-to-day editing, generated-content behavior, and report expectations.
- API-LINK-WORKFLOW.md: API registry flow,
ApiLinkresolution, ambiguity handling, and checker commands. - migration.md: MDX migration rules and component examples.
Open a pull request against this repository and request review from the documentation team.