igniteui-docfx-template v3.7.3
Ignite UI DocFX Template
This is a DocFX template which is used for Ignite UI documentation websites.
Contributing
Check out the Contributing page for more.
Setup
To setup the project run:
npm install
To build the project
npm run build
To run the template in dev mode:
npm run build:dev
Link and Debug
In order to run the template locally, after it is build, it should be linked to the repo you want to use it.
Go to dist/ folder of the template and run:
npm link
Then go to the repo which you want to use the template and run this command in the main folder:
npm link igniteui-docfx-template
After these steps are done, you can run your project and it will automatically use the template.
Collapsible code snippets
To generate and display collapsible code snippets on documentation websites, follow these steps:
Create a \ section with the class "fancy-details".
Add a \ element to the created \ section.
Add the summary text representing the code snippet header to the \ element.
Add a \ element to the created \ section.
Add the code snippet to the \ element.
Example:
<div class="fancy-details">
<summary>Example of a successful response body: </summary>
<code>
{
"id": "{123456}_repo",
"modified": "2023-02-03T14:07:34.0000000",
"created": "2023-02-03T14:07:34.0000000",
"name": "Marketing",
"user": {
"id": "{123456}_u ",
"name": "Teddy Mitkova"
},
"dashboardSections": [
{
"id": "{123456}_f",
"name": "May"
}
]
}
</code>
</div>
2 days ago
3 days ago
12 days ago
23 days ago
1 month ago
2 months ago
5 months ago
8 months ago
10 months ago
11 months ago
12 months ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago