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://rubix-documents.vercel.app/

Table of Contents

• Installation
• Usage
• Features
• Contributing
• License
• Contact

Documentation

https://docs.rubixstudios.com.au (In-Development)

Development

Installation

1. Clone the repository:

   git clone https://github.com/rubixvi/rubix-documents.git
   cd rubix-documents

2. Install dependencies:

   npm install

3. Run the development server:

   npm run dev

4. Open http://localhost:3000 in your browser to see the project.

5. For Production:

   • Build the app:

     npm run build

   • Start the production server:

     npm run start

   • Open 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.

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 file for details.

Contact

For support or inquiries, contact Vincent Vu @rubixvi on X.

Rubix Studios - https://www.rubixstudios.com.au

Project: https://github.com/rubixvi/rubix-documents