https://github.com/igniteui/igniteui-docfx-template

https://github.com/igniteui/igniteui-docfx-template

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/igniteui/igniteui-docfx-template
• Owner: IgniteUI
• Created: 2018-05-22T10:54:01.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2024-04-04T12:50:11.000Z (9 months ago)
• Last Synced: 2024-04-10T09:30:34.089Z (9 months ago)
• Language: TypeScript
• Size: 3.82 MB
• Stars: 7
• Watchers: 44
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: .github/CONTRIBUTING.md

Awesome Lists containing this project

README

        
[![npm version](https://badge.fury.io/js/igniteui-docfx-template.svg)](https://badge.fury.io/js/igniteui-docfx-template)

# Ignite UI DocFX Template

This is a [DocFX](https://github.com/dotnet/docfx) template which is used for [Ignite UI](https://github.com/igniteui) documentation websites.

## Contributing

Check out the [Contributing page](.github/CONTRIBUTING.md) 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:

1. Create a \
 section with the class "fancy-details".


2. Add a \ element to the created \
 section.


3. Add the summary text representing the code snippet header to the \ element.

4.  Add a \ element to the created \
 section.


5. Add the code snippet to the \ element.


6. Example:

```



    Example of a successful response body: 

    

        {

            "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"

                }

            ]

        }

    



```