Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Aleksandyr authored May 17, 2021
1 parent 976238b commit 3e46049
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,10 @@
# ig-typedoc-theme
Feel and look of Infragistics API documentation with internationalization

This package extends [igniteui-typedoc-theme](https://github.com/IgniteUI/igniteui-typedoc-theme) and represents the feel and look of the infragistics API **EN** and **JP** typedoc documentations.
There are a specific global header and footer declarations that could be easily edited based on user's preferences.

It includes specific internationalization configurations and depends on the [typedoc plugin](https://github.com/IgniteUI/typedoc-plugin-localization) package.

The output of the theme could be seen on:
* [EN API web app](https://www.infragistics.com/products/ignite-ui-angular/docs/typescript/latest/)
* [JP API web app](https://jp.infragistics.com/products/ignite-ui-angular/docs/typescript/latest/)

0 comments on commit 3e46049

Please sign in to comment.