https://github.com/conorluddy/residents-docs
Website with documentation for the main Residents repo
https://github.com/conorluddy/residents-docs
documentation express
Last synced: about 2 months ago
JSON representation
Website with documentation for the main Residents repo
- Host: GitHub
- URL: https://github.com/conorluddy/residents-docs
- Owner: conorluddy
- License: mit
- Created: 2024-10-16T05:35:14.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-17T07:52:35.000Z (over 1 year ago)
- Last Synced: 2025-03-03T08:30:55.307Z (over 1 year ago)
- Topics: documentation, express
- Language: TypeScript
- Homepage: https://residents-docs.vercel.app
- Size: 2.19 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Documents
**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.
**Demo**: [https://residents.rest/](https://residents.rest/)
[](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fconorluddy%2Fresidents-documents&project-name=my-documents&repository-name=my-documents&demo-title=Documents&demo-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.&demo-url=https%3A%2F%2Fresidents.rest%2F&demo-image=https%3A%2F%2Fgithub.com%2Fconorluddy%2Fresidents-documents%2Fblob%2Fmain%2Fpublic%2Fscreens%2Fscreen-1.png)
## Table of Contents
- [Installation](#installation)
- [Usage](#usage)
- [Features](#features)
- [Contributing](#contributing)
- [License](#license)
- [Contact](#contact)
## Documentation
[https://www.residents.rest](https://www.residents.rest) **(In-Development)**
## Development
### Installation
1. Clone the repository:
```bash
git clone https://github.com/conorluddy/residents-documents.git
cd residents-documents
```
2. Install dependencies:
```bash
npm install
```
3. Run the development server:
```bash
npm run dev
```
4. Open [http://localhost:3000](http://localhost:3000) in your browser to see the project.
5. **For Production:**
- Build the app:
```bash
npm run build
```
- Start the production server:
```bash
npm run start
```
- Open [http://localhost:3000](http://localhost:3000) to view the production build.
- **If deploying to Vercel,** the build step is automatically handled during deployment.
## Usage
This kit can be used to create product documentation, business websites and guides.
_Main Screen_
_Document Screen_
_Document Footer_
_Document Search_
_Main Dark Mode Screen_
_Document Dark Mode Screen_
## Features
### Content Creation
- **MDX Integration**: Write docs with Markdown & JSX components.
- **Custom Components**: Reuse React components in your docs.
- **Mermaid.js Diagrams**: Create flowcharts & diagrams.
- **Math & Tables**: Include tables & LaTeX math formulas.
### Navigation & Readability
- **Multi-level Navigation**: Nested pages for hierarchy.
- **Content Pagination**: Smooth transitions between pages.
- **Dynamic TOC**: Auto-generated table of contents.
- **Code Switcher**: Toggle & copy code snippets easily.
### Code Features
- **Syntax Highlighting**: Theme-aware highlighting.
- **Enhanced Code Blocks**: Line highlighting & code titles.
### Theming & UX
- **Light/Dark Modes**: Automatic theme switching.
- **SEO Optimization**: Auto-generated metadata for better ranking.
- Manage meta tags (title, description, URLs, social sharing).
### Search & Future Enhancements
- **Advanced Search**: Fuzzy search with term highlighting.
- **AI Knowledgebase**: Future AI-powered doc tools.
> **Note:** AI documentation support is in development.
## Contributing
1. Fork the repository.
2. Create a new branch (`git checkout -b feature-branch`).
3. Make your changes.
4. Commit your changes (`git commit -m 'Add some feature'`).
5. Push to the branch (`git push origin feature-branch`).
6. Open a pull request.
## License
This project is licensed under the MIT License. See the [LICENSE](./LICENSE) file for details.
## Contact
For support or inquiries, contact Vincent Vu [@conorluddy](https://x.com/conorluddy) on X.
Residents - [https://www.residents.rest](https://www.residents.rest)
Project: [https://github.com/conorluddy/residents-documents](https://github.com/conorluddy/residents-documents)