https://github.com/igniteui/igniteui-blazor-api
this project generates API docs for Ignite UI for Blazor components
https://github.com/igniteui/igniteui-blazor-api
api blazor docs igniteui webassembly
Last synced: about 1 month ago
JSON representation
this project generates API docs for Ignite UI for Blazor components
- Host: GitHub
- URL: https://github.com/igniteui/igniteui-blazor-api
- Owner: IgniteUI
- Created: 2022-02-15T15:00:01.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2026-03-18T15:16:07.000Z (3 months ago)
- Last Synced: 2026-03-19T02:49:30.200Z (3 months ago)
- Topics: api, blazor, docs, igniteui, webassembly
- Language: JavaScript
- Homepage: https://www.infragistics.com/blazor-apps/blazor-api/api/index.html
- Size: 1.76 MB
- Stars: 3
- Watchers: 27
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Ignite UI for Blazor API
This project generates API documentation for **Ignite UI for Blazor** components by:
- restoring IgniteUI.Blazor packages in the `app` folder
- installing npm packages
- building Blazor API project
## Install DocFX
- run `choco install docfx -y` command
## Setup Blazor Application
This section will guide you to setup a blazor application in the `app` folder:
- in notepad, open `/app/blazor-app.csproj` file
- update version of IgniteUI packages to latest version
- open **VS Code** terminal window
- run `cd app` command
- run `dotnet restore --force` command
- run `dotnet build --force` command
## Setup Blazor API
This section will guide you to setup docs project in the root for this repo:
- run `cd ..` command
- run `npm install` command
## Building Blazor API
This section builds a website for Blazor API:
- run `gulp build` to generate output files in `_site` folder
- copy content of the `_site` folder to hosting server
## Updating API Landing Page
This section explains how to update [API Landing Page](https://staging.infragistics.com/blazor/docs/api/api/index.html)
- open `index-links.json` file
- add entries for new API members (if any), where `api` is name of API component, and `url` is routing path for a topic that provides documentation and examples of the API component
```
{ "api": "IgbTreeGrid", "links": [ { "url": "/grids/tree-grid/overview" }] },
```
- run `gulp updateIndex` to generate a table with API mapping to topics in `index.md` files
- commit your changes and create a new Pull Request