{"id":18600184,"url":"https://github.com/igniteui/igniteui-docfx-template","last_synced_at":"2025-04-10T18:31:21.883Z","repository":{"id":37768222,"uuid":"134401739","full_name":"IgniteUI/igniteui-docfx-template","owner":"IgniteUI","description":null,"archived":false,"fork":false,"pushed_at":"2025-03-27T12:02:17.000Z","size":4546,"stargazers_count":7,"open_issues_count":6,"forks_count":0,"subscribers_count":44,"default_branch":"master","last_synced_at":"2025-04-04T11:41:58.469Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/IgniteUI.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":".github/CONTRIBUTING.md","funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2018-05-22T10:54:01.000Z","updated_at":"2025-03-27T08:22:40.000Z","dependencies_parsed_at":"2024-04-15T13:55:33.983Z","dependency_job_id":"a752baf0-2570-4e37-b069-ce2fa1317d32","html_url":"https://github.com/IgniteUI/igniteui-docfx-template","commit_stats":{"total_commits":595,"total_committers":32,"mean_commits":18.59375,"dds":0.611764705882353,"last_synced_commit":"37dc62299c627958649c521e9abe59fb50fbf2b7"},"previous_names":[],"tags_count":189,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IgniteUI%2Figniteui-docfx-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IgniteUI%2Figniteui-docfx-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IgniteUI%2Figniteui-docfx-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IgniteUI%2Figniteui-docfx-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/IgniteUI","download_url":"https://codeload.github.com/IgniteUI/igniteui-docfx-template/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248271643,"owners_count":21075800,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-07T02:03:20.187Z","updated_at":"2025-04-10T18:31:21.272Z","avatar_url":"https://github.com/IgniteUI.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![npm version](https://badge.fury.io/js/igniteui-docfx-template.svg)](https://badge.fury.io/js/igniteui-docfx-template)\n\n# Ignite UI DocFX Template\nThis is a [DocFX](https://github.com/dotnet/docfx) template which is used for [Ignite UI](https://github.com/igniteui) documentation websites.\n\n## Contributing\nCheck out the [Contributing page](.github/CONTRIBUTING.md) for more.\n\n## Setup\nTo setup the project run:\n\n```\nnpm install\n```\n\nTo build the project\n\n```\nnpm run build\n```\n\nTo run the template in dev mode:\n\n```\nnpm run build:dev\n```\n## Link and Debug\n\nIn order to run the template locally, after it is build, it should be linked to the repo you want to use it.\n\nGo to __dist/__ folder of the template and run:\n\n```\nnpm link\n```\n\nThen go to the repo which you want to use the template and run this command in the main folder:\n\n```\nnpm link igniteui-docfx-template\n```\n\nAfter these steps are done, you can run your project and it will automatically use the template.\n\n## Collapsible code snippets\n\nTo generate and display collapsible code snippets on documentation websites, follow these steps:\n\n1. Create a \\\u003cdiv\u003e section with the class \"fancy-details\".\n\n2. Add a \\\u003csummary\u003e element to the created \\\u003cdiv\u003e section.\n\n3. Add the summary text representing the code snippet header to the \\\u003csummary\u003e element.\n\n4.  Add a \\\u003ccode\u003e element to the created \\\u003cdiv\u003e section.\n\n5. Add the code snippet to the \\\u003ccode\u003e element.\n\n6. Example:\n```\n\u003cdiv class=\"fancy-details\"\u003e\n    \u003csummary\u003eExample of a successful response body: \u003c/summary\u003e\n    \u003ccode\u003e\n        {\n            \"id\": \"{123456}_repo\",\n            \"modified\": \"2023-02-03T14:07:34.0000000\",\n            \"created\": \"2023-02-03T14:07:34.0000000\",\n            \"name\": \"Marketing\",\n            \"user\": {\n                \"id\": \"{123456}_u \",\n                \"name\": \"Teddy Mitkova\"\n            },\n            \"dashboardSections\": [\n                {\n                    \"id\": \"{123456}_f\",\n                    \"name\": \"May\"\n                }\n            ]\n        }\n    \u003c/code\u003e\n\u003c/div\u003e\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Figniteui%2Figniteui-docfx-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Figniteui%2Figniteui-docfx-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Figniteui%2Figniteui-docfx-template/lists"}