{"id":15044049,"url":"https://github.com/rubixvi/rubix-documents","last_synced_at":"2025-04-09T10:05:44.022Z","repository":{"id":256804816,"uuid":"856485464","full_name":"rubixvi/rubix-documents","owner":"rubixvi","description":"Documents is a powerful and flexible Next.js documentation starter kit designed to simplify the process of creating high-quality, comprehensive product documentation, technical manuals and business guides.","archived":false,"fork":false,"pushed_at":"2025-03-29T12:50:40.000Z","size":2363,"stargazers_count":63,"open_issues_count":0,"forks_count":26,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-04-02T08:49:31.394Z","etag":null,"topics":["documentation","documentation-template","documentation-website","fuzzy-search","husky","markdown","nextjs","nodejs","react","tailwindcss","template","typescript","vercel","vercel-deployment"],"latest_commit_sha":null,"homepage":"https://www.rubixstudios.com.au/","language":"TypeScript","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/rubixvi.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","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},"funding":{"github":"rubixvi","buy_me_a_coffee":"rubixstudios"}},"created_at":"2024-09-12T16:49:31.000Z","updated_at":"2025-03-29T12:50:44.000Z","dependencies_parsed_at":"2024-09-13T05:49:42.836Z","dependency_job_id":"39b3a008-951c-491f-9672-652f3f55b2a3","html_url":"https://github.com/rubixvi/rubix-documents","commit_stats":null,"previous_names":["rubixvi/rubix-studios-documents"],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rubixvi%2Frubix-documents","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rubixvi%2Frubix-documents/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rubixvi%2Frubix-documents/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rubixvi%2Frubix-documents/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rubixvi","download_url":"https://codeload.github.com/rubixvi/rubix-documents/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248018060,"owners_count":21034048,"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":["documentation","documentation-template","documentation-website","fuzzy-search","husky","markdown","nextjs","nodejs","react","tailwindcss","template","typescript","vercel","vercel-deployment"],"created_at":"2024-09-24T20:50:00.192Z","updated_at":"2025-04-09T10:05:43.973Z","avatar_url":"https://github.com/rubixvi.png","language":"TypeScript","funding_links":["https://github.com/sponsors/rubixvi","https://buymeacoffee.com/rubixstudios"],"categories":[],"sub_categories":[],"readme":"# Documents\n\n**Documents** is a powerful **Next.js** documentation starter kit designed to simplify the process of creating high-quality, comprehensive product documentation, technical manuals and business guides. Built with **React**, **Tailwind CSS** and **TypeScript**, this starter kit provides the foundation to build your project documentation and knowledge base.\n\n**Demo**: [https://rubix-documents.vercel.app/](https://rubix-documents.vercel.app/)\n\n[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Frubixvi%2Frubix-documents\u0026project-name=my-documents\u0026repository-name=my-documents\u0026demo-title=Documents\u0026demo-description=This%20Document%20Starter%20Kit%20is%20developed%20with%20Next.js%2C%20Tailwind%20CSS%20and%20TypeScript.%20It%20serves%20as%20a%20flexible%20and%20scalable%20foundation%20for%20building%20documentation%20websites%20or%20content-driven%20projects.\u0026demo-url=https%3A%2F%2Frubix-documents.vercel.app%2F\u0026demo-image=https%3A%2F%2Fgithub.com%2Frubixvi%2Frubix-documents%2Fblob%2Fmain%2Fpublic%2Fscreens%2Fscreen-1.png)\n\n## Table of Contents\n\n- [Installation](#installation)\n- [Usage](#usage)\n- [Features](#features)\n- [Contributing](#contributing)\n- [License](#license)\n- [Contact](#contact)\n\n## Documentation\n\n[https://docs.rubixstudios.com.au](https://docs.rubixstudios.com.au) **(In-Development)**\n\n## Development\n\n### Installation\n\n1. Clone the repository:\n\n   ```bash\n   git clone https://github.com/rubixvi/rubix-documents.git\n   cd rubix-documents\n   ```\n\n2. Install dependencies:\n\n   ```bash\n   npm install\n   ```\n\n3. Run the development server:\n\n   ```bash\n   npm run dev\n   ```\n\n4. Open [http://localhost:3000](http://localhost:3000) in your browser to see the project.\n\n5. **For Production:**\n\n   - Build the app:\n\n     ```bash\n     npm run build\n     ```\n\n   - Start the production server:\n\n     ```bash\n     npm run start\n     ```\n\n   - Open [http://localhost:3000](http://localhost:3000) to view the production build.\n\n   - **If deploying to Vercel,** the build step is automatically handled during deployment.\n\n## Usage\n\nThis kit can be used to create product documentation, business websites and guides.\n\n![Main Screen](./public/screens/screen-1.png)\n_Main Screen_\n\n![Document Screen](./public/screens/screen-2.png)\n_Document Screen_\n\n![Document Footer](./public/screens/screen-3.png)\n_Document Footer_\n\n![Document Search](./public/screens/screen-4.png)\n_Document Search_\n\n![Main Dark Screen](./public/screens/screen-5.png)\n_Main Dark Mode Screen_\n\n![Document Dark Screen](./public/screens/screen-6.png)\n_Document Dark Mode Screen_\n\n## Features\n\n### Content Creation\n\n- **MDX Integration**: Write docs with Markdown \u0026 JSX components.\n- **Custom Components**: Reuse React components in your docs.\n- **Mermaid.js Diagrams**: Create flowcharts \u0026 diagrams.\n- **Math \u0026 Tables**: Include tables \u0026 LaTeX math formulas.\n\n### Navigation \u0026 Readability\n\n- **Multi-level Navigation**: Nested pages for hierarchy.\n- **Content Pagination**: Smooth transitions between pages.\n- **Dynamic TOC**: Auto-generated table of contents.\n- **Code Switcher**: Toggle \u0026 copy code snippets easily.\n\n### Code Features\n\n- **Syntax Highlighting**: Theme-aware highlighting.\n- **Enhanced Code Blocks**: Line highlighting \u0026 code titles.\n\n### Theming \u0026 UX\n\n- **Light/Dark Modes**: Automatic theme switching.\n- **SEO Optimization**: Auto-generated metadata for better ranking.\n  - Manage meta tags (title, description, URLs, social sharing).\n\n### Search \u0026 Future Enhancements\n\n- **Advanced Search**: Fuzzy search with term highlighting.\n- **AI Knowledgebase**: Future AI-powered doc tools.\n\n\u003e **Note:** AI documentation support is in development.\n\n## Contributing\n\n1. Fork the repository.\n2. Create a new branch (`git checkout -b feature-branch`).\n3. Make your changes.\n4. Commit your changes (`git commit -m 'Add some feature'`).\n5. Push to the branch (`git push origin feature-branch`).\n6. Open a pull request.\n\n## License\n\nThis project is licensed under the MIT License. See the [LICENSE](./LICENSE) file for details.\n\n## Contact\n\nFor support or inquiries, contact Vincent Vu [@rubixvi](https://x.com/rubixvi) on X.\n\nRubix Studios - [https://www.rubixstudios.com.au](https://www.rubixstudios.com.au)\n\nProject: [https://github.com/rubixvi/rubix-documents](https://github.com/rubixvi/rubix-documents)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frubixvi%2Frubix-documents","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frubixvi%2Frubix-documents","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frubixvi%2Frubix-documents/lists"}