{"id":20198919,"url":"https://github.com/conorluddy/residents-docs","last_synced_at":"2026-05-01T20:32:08.902Z","repository":{"id":260091980,"uuid":"873403293","full_name":"conorluddy/residents-docs","owner":"conorluddy","description":"Website with documentation for the main Residents repo","archived":false,"fork":false,"pushed_at":"2025-01-17T07:52:35.000Z","size":2293,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-03T08:30:55.307Z","etag":null,"topics":["documentation","express"],"latest_commit_sha":null,"homepage":"https://residents-docs.vercel.app","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/conorluddy.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":"conorluddy","buy_me_a_coffee":"residents"}},"created_at":"2024-10-16T05:35:14.000Z","updated_at":"2025-01-17T07:52:37.000Z","dependencies_parsed_at":"2025-01-13T19:51:15.856Z","dependency_job_id":"5d7c9062-edc3-4cec-b220-bd3a11053020","html_url":"https://github.com/conorluddy/residents-docs","commit_stats":null,"previous_names":["conorluddy/residents-docs"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/conorluddy/residents-docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/conorluddy%2Fresidents-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/conorluddy%2Fresidents-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/conorluddy%2Fresidents-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/conorluddy%2Fresidents-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/conorluddy","download_url":"https://codeload.github.com/conorluddy/residents-docs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/conorluddy%2Fresidents-docs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32512662,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-30T13:12:12.517Z","status":"online","status_checked_at":"2026-05-01T02:00:05.856Z","response_time":64,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":["documentation","express"],"created_at":"2024-11-14T04:34:52.158Z","updated_at":"2026-05-01T20:32:08.880Z","avatar_url":"https://github.com/conorluddy.png","language":"TypeScript","funding_links":["https://github.com/sponsors/conorluddy","https://buymeacoffee.com/residents"],"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://residents.rest/](https://residents.rest/)\n\n[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fconorluddy%2Fresidents-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%2Fresidents.rest%2F\u0026demo-image=https%3A%2F%2Fgithub.com%2Fconorluddy%2Fresidents-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://www.residents.rest](https://www.residents.rest) **(In-Development)**\n\n## Development\n\n### Installation\n\n1. Clone the repository:\n\n   ```bash\n   git clone https://github.com/conorluddy/residents-documents.git\n   cd residents-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 [@conorluddy](https://x.com/conorluddy) on X.\n\nResidents - [https://www.residents.rest](https://www.residents.rest)\n\nProject: [https://github.com/conorluddy/residents-documents](https://github.com/conorluddy/residents-documents)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fconorluddy%2Fresidents-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fconorluddy%2Fresidents-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fconorluddy%2Fresidents-docs/lists"}