Skip to content

GavinCnod/mindrose-ui

Repository files navigation

Mindrose UI

A Repo and A Collection of React Components / Backgrounds / Icons / etc.

Build with Next.js, React, Tailwind CSS, TypeScript.

Build in Mindrose Team's daily Develepment.

Open-source and free to use.

Not a Production Ready Website and Repo yep.

Maybe a Production Ready Repo before Sep 15, 2025.

The Basic Template's Documents

Documents is a modern documentation starter kit built with Next.js, React, Tailwind CSS, and TypeScript. Designed for businesses, product teams, and technical writers, it provides a scalable and efficient foundation for building documentation websites, product manuals, and knowledge bases.

Demo: https://rubix-documents.vercel.app

License Top Language

GitHub commit activity Last Commit GitHub issues GitHub pull requests

GitHub stars GitHub forks GitHub repo size

Deploy with Vercel


Overview

Documents enables businesses to deliver clear, structured, and accessible product documentation — with a focus on performance, usability, and maintainability.

Built for technical and content-driven projects, this starter kit supports Markdown (MDX), React components, and a flexible content architecture designed for scale.


Features

Content Management

  • MDX support (Markdown with React components)
  • Reusable custom components
  • Mermaid.js for diagrams and flowcharts
  • Tables and LaTeX math support

Navigation & Structure

  • Multi-level navigation
  • Auto-generated table of contents
  • Content pagination
  • Code snippet switcher with copy functionality

Development Experience

  • Syntax highlighting with theme support
  • Enhanced code blocks with titles and line highlighting
  • Built-in light/dark mode with auto-detection
  • SEO-ready with dynamic meta tags

Search & Future Enhancements

  • Fuzzy search with term highlighting
  • Planned: AI-powered knowledgebase tools

Quick Start

Installation

git clone https://github.com/rubixvi/rubix-documents.git
cd rubix-documents
npm install
npm run dev

Visit http://localhost:3000 to view your project locally.

For production:

npm run build
npm run start

Deploy to Vercel for automated builds and hosting.


Usage

Documents is designed to support:

  • Product documentation
  • Technical manuals
  • Internal guides
  • Business knowledge bases

Screenshots

Main Screen Main Screen

Document Screen Document Screen

Document Footer Document Footer

Document Search Document Search

Main Dark Screen Main Dark Mode Screen

Document Dark Screen Document Dark Mode Screen


Contributing

We welcome contributions to improve this project.

  1. Fork the repository
  2. Create a feature branch
  3. Commit your changes
  4. Open a pull request

License

This project is licensed under the MIT License. See the LICENSE file for details.


Contact

For support or inquiries:

Vincent Vu — @rubixvi

Rubix Studios — https://rubixstudios.com.au

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

About

UI components and other UI elements from Mindrose Team's daily experience.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Sponsor this project

Packages

 
 
 

Contributors

Generated from rubixvi/rubix-documents