Git Product home page Git Product logo

igniteui-blazor-api's Introduction

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

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

  • 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

igniteui-blazor-api's People

Contributors

gmurray81 avatar hussar-mtrela avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

igniteui-blazor-api's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.