Skip to content

Commit

Permalink
chore(*): update readme and package.josn
Browse files Browse the repository at this point in the history
  • Loading branch information
Aleksandyr committed May 27, 2021
1 parent 864495c commit 035c921
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 7 deletions.
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
# igniteui-typedoc-theme
![Build Status](https://travis-ci.org/IgniteUI/igniteui-typedoc-theme.svg?branch=master)
# ig-typedoc-theme

This package represents the feel and look of the infragistics API typedoc documentations.
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.

The output of the theme could be seen on [this web app](https://www.infragistics.com/products/ignite-ui-angular/docs/typescript/latest/)
It includes specific internationalization configurations and depends on the [typedoc plugin](https://github.com/IgniteUI/typedoc-plugin-localization) package.

Example: This theme is used by other documentations within (or external) of the Infragistics organization - e.g. Reveal API documentation. Using of the theme externaly is also possible.
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/)
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@
],
"scripts": {
"build": "webpack --mode=production --node-env=production && gulp buildTypedocTs",
"build:dev": "webpack --mode=development",
"build:prod": "webpack --mode=production --node-env=production",
"build:dev": "webpack --mode=development && gulp buildTypedocTs",
"build:prod": "webpack --mode=production --node-env=production && gulp buildTypedocTs",
"watch": "webpack --watch",
"serve": "webpack serve"
},
Expand Down

0 comments on commit 035c921

Please sign in to comment.