![\"npm](\"https://img.shields.io/npm/v/typedoc-rhineai-theme.svg\")
\n \n \n ![\"npm](\"https://img.shields.io/npm/dm/typedoc-rhineai-theme.svg\")
\n \n \n ![\"license\"](\"https://img.shields.io/npm/l/typedoc-rhineai-theme.svg\")
\n \n \n ![\"GitHub](\"https://img.shields.io/github/stars/RhineAI/typedoc-rhineai-theme.svg?style=social\")
\n \n\n A carefully designed, detail-refined GitHub-style TypeDoc theme.\n
\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
\n Features •\n Preview •\n Installation •\n Usage •\n Contributing •\n License\n
\n\n\n## Features\n\n- **GitHub-Style Design** - Clean, familiar interface inspired by GitHub's documentation style\n- **Dark Mode Support** - Automatic theme switching based on system preferences\n- **Responsive Layout** - Works seamlessly on desktop, tablet, and mobile devices\n- **Syntax Highlighting** - Beautiful code blocks with language-specific highlighting\n- **Zero Configuration** - Works out of the box with sensible defaults\n- **Fast & Lightweight** - Optimized for performance with minimal bundle size\n\n## Preview\n\n\n \n ![\"TypeDoc](\"./example.png\")
\n \n
\n View Live Demo\n
\n\n## Installation\n\n```bash\n# Using npm\nnpm install typedoc-rhineai-theme --save-dev\n\n# Using yarn\nyarn add typedoc-rhineai-theme --dev\n\n# Using pnpm\npnpm add typedoc-rhineai-theme --save-dev\n\n# Using bun\nbun add typedoc-rhineai-theme --dev\n```\n\n### Requirements\n\n- Node.js >= 18.0.0\n- TypeDoc ~0.28\n\n## What is TypeDoc?\n\n[TypeDoc](https://typedoc.org/) is a documentation generator for TypeScript projects. It reads your TypeScript source code and JSDoc comments, then generates static HTML documentation automatically.\n\nIf you're new to TypeDoc, visit [typedoc.org](https://typedoc.org/) to learn how to get started.\n\n## Usage\n\n### Basic Setup\n\nAdd the theme to your `typedoc.json` configuration file:\n\n```json\n{\n \"$schema\": \"https://typedoc.org/schema.json\",\n \"name\": \"My Project\",\n \"entryPoints\": [\"./src\"],\n \"out\": \"./docs\",\n \"plugin\": [\"typedoc-rhineai-theme\"]\n}\n```\n\nThen run TypeDoc:\n\n```bash\nnpx typedoc\n```\n\n### Command Line Usage\n\nYou can also use the theme directly from the command line:\n\n```bash\nnpx typedoc --plugin typedoc-rhineai-theme --entryPoints ./src --out ./docs\n```\n\n### Programmatic Usage\n\n```typescript\nimport { Application } from 'typedoc';\n\nconst app = await Application.bootstrap({\n entryPoints: ['./src'],\n plugin: ['typedoc-rhineai-theme'],\n});\n\nconst project = await app.convert();\nif (project) {\n await app.generateDocs(project, './docs');\n}\n```\n\n## Development\n\n### Prerequisites\n\n- [Bun](https://bun.sh/) - Fast JavaScript runtime and package manager\n\n### Setup\n\n```bash\n# Clone the repository\ngit clone https://github.com/RhineAI/typedoc-rhineai-theme.git\ncd typedoc-rhineai-theme\n\n# Install dependencies\nbun install\n\n# Build the project\nbun run build\n```\n\n### Scripts\n\n| Script | Description |\n|--------|-------------|\n| `bun run build` | Compile TypeScript to JavaScript |\n| `bun run example` | Build and preview the example documentation |\n| `bun run type:check` | Run TypeScript type checking |\n| `bun run lint` | Run ESLint and fix issues |\n| `bun run lint:check` | Run ESLint without fixing |\n| `bun run format` | Format code with Prettier |\n| `bun run format:check` | Check code formatting |\n\n### Project Structure\n\n```\ntypedoc-rhineai-theme/\n├── src/ # Source code\n│ ├── assets/ # Theme assets (CSS, JS)\n│ ├── partials/ # JSX template partials\n│ ├── public/ # Static files (favicon, manifest)\n│ ├── index.tsx # Plugin entry point\n│ └── rhineai-theme.tsx # Theme class definition\n├── example/ # Example project for testing\n├── docs/ # Generated documentation output\n├── dist/ # Compiled output\n└── package.json\n```\n\n## Issues\n1. Due to our overly aggressive UI-aesthetics-first approach, we have hidden all scrollbars. If needed, you can fork this repository and modify the CSS.\n2. Not fully tested yet, and it is still unclear whether it works well across all projects and in all UI scenarios. If you encounter any issues, please open an issue.\n3. More suitable for dark themes.\n\n## Contributing\n\nWe welcome contributions! Here's how you can help:\n\n1. **Fork** the repository\n2. **Create** a feature branch (`git checkout -b feature/amazing-feature`)\n3. **Commit** your changes (`git commit -m 'Add amazing feature'`)\n4. **Push** to the branch (`git push origin feature/amazing-feature`)\n5. **Open** a Pull Request\n\n### Guidelines\n\n- Follow the existing code style\n- Write clear commit messages\n- Update documentation as needed\n- Add tests for new features when applicable\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n## Acknowledgments\n\n- [TypeDoc](https://typedoc.org/) - The documentation generator this theme is built for\n\n---\n\n\n Made by RHINE.AI\n
\n","readmeFilename":"README.md"}