{"id":28386460,"url":"https://github.com/igniteui/igniteui-sassdoc-theme","last_synced_at":"2026-03-07T07:32:37.983Z","repository":{"id":53017349,"uuid":"202689064","full_name":"IgniteUI/igniteui-sassdoc-theme","owner":"IgniteUI","description":"Custom sassdoc theme","archived":false,"fork":false,"pushed_at":"2025-10-06T10:19:27.000Z","size":1190,"stargazers_count":0,"open_issues_count":5,"forks_count":0,"subscribers_count":39,"default_branch":"master","last_synced_at":"2025-10-06T12:11:45.582Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"SCSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/IgniteUI.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2019-08-16T08:25:37.000Z","updated_at":"2025-10-06T10:19:02.000Z","dependencies_parsed_at":"2023-12-11T09:25:38.422Z","dependency_job_id":"e46454ca-d9c5-490d-bdee-f788f5717126","html_url":"https://github.com/IgniteUI/igniteui-sassdoc-theme","commit_stats":null,"previous_names":[],"tags_count":23,"template":false,"template_full_name":null,"purl":"pkg:github/IgniteUI/igniteui-sassdoc-theme","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IgniteUI%2Figniteui-sassdoc-theme","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IgniteUI%2Figniteui-sassdoc-theme/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IgniteUI%2Figniteui-sassdoc-theme/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IgniteUI%2Figniteui-sassdoc-theme/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/IgniteUI","download_url":"https://codeload.github.com/IgniteUI/igniteui-sassdoc-theme/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IgniteUI%2Figniteui-sassdoc-theme/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30209731,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-07T05:23:27.321Z","status":"ssl_error","status_checked_at":"2026-03-07T05:00:17.256Z","response_time":53,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":"2025-05-30T14:43:09.368Z","updated_at":"2026-03-07T07:32:37.971Z","avatar_url":"https://github.com/IgniteUI.png","language":"SCSS","readme":"# Ignite UI SassDoc Theme\n\n[![npm version](https://badge.fury.io/js/igniteui-sassdoc-theme.svg)](https://badge.fury.io/js/igniteui-sassdoc-theme)\n\nA specialized SassDoc theme built specifically for **Infragistics' Ignite UI** component libraries. This theme generates comprehensive, searchable documentation websites for Sass/SCSS APIs with integrated Infragistics branding, global navigation, and enhanced user experience features.\n\n## Overview\n\nThis package provides a complete documentation generation solution tailored to Infragistics' Ignite UI ecosystem, including:\n\n- **Custom SassDoc Theme**: Built with Astro and TypeScript for modern, fast documentation sites\n- **Infragistics Branding**: Integrated global navigation, footer, and styling consistent with Infragistics websites\n- **Enhanced Search**: Full-text search capabilities powered by Pagefind\n- **Responsive Design**: Mobile-first responsive layout using Ignite UI theming system\n- **Multi-language Support**: Built-in internationalization support (English/Japanese)\n- **Plugin Architecture**: Extensible plugin system for custom functionality\n\nThe theme transforms Sass documentation comments into professional, interactive documentation websites like the [Ignite UI for Angular Sass API docs](https://www.infragistics.com/products/ignite-ui-angular/docs/sass/latest/).\n\n## Features\n\n### 🎨 **Ignite UI Integration**\n- Seamless integration with Infragistics' design system and theming\n- Global navigation and footer matching Infragistics.com\n- Consistent styling with other Ignite UI documentation\n\n### 🔍 **Advanced Search**\n- Full-text search across all documentation content\n- Real-time search with highlighted results\n- Search dialog with keyboard navigation\n\n### 📱 **Modern Architecture**\n- Built with Astro for optimal performance and SEO\n- Component-based architecture with reusable UI elements\n- Static site generation with fast client-side navigation\n\n### 🌐 **Internationalization**\n- Support for multiple languages (English, Japanese)\n- Localized navigation and UI elements\n- Language-specific metadata and content\n\n### 🔧 **Developer Experience**\n- Plugin system for extending functionality\n- TypeScript support throughout\n- Hot module replacement during development\n- Comprehensive error handling and logging\n\n## Installation\n\n```bash\nnpm install igniteui-sassdoc-theme\n```\n\n## Usage\n\n### Basic Configuration\n\nCreate a `sassdoc.config.json` file in your project:\n\n```json\n{\n  \"theme\": \"igniteui-sassdoc-theme\",\n  \"dest\": \"./docs\",\n  \"autofill\": [\"throw\", \"content\"],\n  \"display\": {\n    \"alias\": true,\n    \"access\": [\"public\", \"private\"]\n  }\n}\n```\n\n### Generate Documentation\n\n```bash\n# Using SassDoc CLI\nsassdoc src/scss -c sassdoc.config.json\n\n# Using npm script\nnpm run compile\n```\n\n## Configuration Options\n\nThe theme accepts standard SassDoc configuration plus additional options:\n\n```json\n{\n  \"theme\": \"igniteui-sassdoc-theme\",\n  \"dest\": \"./docs\",\n  \"language\": \"en\",\n  \"environment\": \"production\",\n  \"display\": {\n    \"access\": [\"public\", \"private\"],\n    \"alias\": true,\n    \"watermark\": false\n  },\n  \"groups\": {\n    \"undefined\": \"utilities\"\n  },\n  \"plugins\": [\n    {\n      \"name\": \"custom-plugin\",\n      \"path\": \"./plugins/custom-plugin.js\",\n      \"options\": {}\n    }\n  ]\n}\n```\n\n### Theme-Specific Options\n\n- `language`: Documentation language (`\"en\"` or `\"ja\"`)\n- `environment`: Build environment (`\"production\"` or `\"development\"`)\n- `plugins`: Array of plugin configurations for extending functionality\n\n## Development\n\n### Prerequisites\n\n- Node.js 18+ \n- npm 7+\n\n### Setup\n\n```bash\n# Clone the repository\ngit clone https://github.com/IgniteUI/igniteui-sassdoc-theme.git\ncd igniteui-sassdoc-theme\n\n# Install dependencies\nnpm install\n\n# Start development server\nnpm run dev\n```\n\n### Build Process\n\n```bash\n# Build SCSS assets\nnpm run scss:build\n\n# Build the theme\nnpm run build\n\n# Test with sample documentation\nnpm run compile\n```\n\n### Project Structure\n\n```\nsrc/\n├── components/          # Astro UI components\n├── layouts/            # Page layouts\n├── pages/              # Route pages\n├── styles/             # Global styles and theming\n├── utils/              # Utility functions\n├── i18n/              # Internationalization files\n├── theme.ts           # Main theme entry point\n└── annotations.ts     # Custom SassDoc annotations\n\ndata/\n├── navigation.json    # Global navigation data\n└── sassdoc-data.json  # Generated documentation data\n```\n\n## Plugin Development\n\nThe theme supports a plugin architecture for extending functionality:\n\n```javascript\n// Example plugin\nexport default function customPlugin(options = {}) {\n  return {\n    name: 'custom-plugin',\n    \n    // Hook: before data processing\n    beforeProcess(ctx) {\n      // Modify context before processing\n      return false; // Return true to terminate processing\n    },\n    \n    // Hook: after data processing\n    afterProcess(ctx) {\n      // Modify processed data\n    },\n    \n    // Hook: before site build\n    beforeBuild(ctx) {\n      // Pre-build modifications\n    },\n    \n    // Hook: after site build\n    afterBuild(ctx) {\n      // Post-build operations\n    }\n  };\n}\n```\n\n## Contributing\n\nThis theme is specifically designed for Infragistics' Ignite UI documentation needs. For questions or contributions related to Ignite UI integration, please contact the Infragistics development team.\n\n## License\n\nMIT License - see [LICENSE](LICENSE) file for details.\n\n---\n\n**Built for Infragistics Ignite UI** | [Documentation](https://www.infragistics.com/products/ignite-ui-angular/docs/sass/latest/) | [Ignite UI](https://www.infragistics.com/products/ignite-ui)\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Figniteui%2Figniteui-sassdoc-theme","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Figniteui%2Figniteui-sassdoc-theme","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Figniteui%2Figniteui-sassdoc-theme/lists"}