Add initial configuration files and components; remove unused pages

.eslintrc.json

@@ -0,0 +1,3 @@
+{
+  "extends": "next/core-web-vitals"
+}

.github/FUNDING.yml

@@ -0,0 +1,4 @@
+# These are supported funding model platforms
+
+github: rubixvi
+buy_me_a_coffee: rubixstudios

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,38 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/workflows/ci.yml

@@ -0,0 +1,53 @@
+name: Documents Search CI
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v3
+
+    - name: Set up Node.js
+      uses: actions/setup-node@v3
+      with:
+        node-version: '20' # Updated to Node.js 20 as per the GitHub Actions change
+
+    - name: Install dependencies
+      run: npm install
+
+    - name: Compile TypeScript
+      run: npx tsc --project tsconfig.scripts.json
+
+    - name: Rename .js files to .mjs
+      run: |
+        for file in dist/scripts/**/*.js; do
+          mv "$file" "${file%.js}.mjs"
+        done
+
+    - name: Post-process scripts
+      run: |
+        for file in dist/scripts/scripts/content.mjs dist/scripts/lib/pageroutes.mjs; do
+          if [ -f "$file" ]; then
+            echo "Processing $file..."
+            sed -i 's|import { Documents } from '\''@/settings/documents'\''|import { Documents } from '\''../settings/documents.mjs'\''|g' "$file"
+            if [ $? -ne 0 ]; then
+              echo "Error: Failed to update $file"
+              exit 1
+            fi
+            echo "$file updated successfully."
+          else
+            echo "$file not found!"
+          fi
+        done
+
+    - name: Run content script
+      run: node dist/scripts/scripts/content.mjs

.gitignore

@@ -1,2 +1,36 @@
-.next
-node_modules
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+.yarn/install-state.gz
+
+# testing
+/coverage
+
+# next.js
+/.next/
+/out/
+
+# production
+/build
+
+# misc
+.DS_Store
+*.pem
+
+# debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# local env files
+.env*.local
+
+# vercel
+.vercel
+
+# typescript
+*.tsbuildinfo
+next-env.d.ts

.husky/post-process.sh

@@ -0,0 +1,26 @@
+#!/bin/sh
+
+npx tsc --project tsconfig.scripts.json
+
+for file in dist/scripts/**/*.js; do
+  mv "$file" "${file%.js}.mjs"
+done
+
+for file in dist/scripts/scripts/content.mjs dist/scripts/lib/pageroutes.mjs; do
+  if [ -f "$file" ]; then
+    echo "Processing $file..."
+
+    sed -i 's|import { Documents } from '\''@/settings/documents'\''|import { Documents } from '\''../settings/documents.mjs'\''|g' "$file"
+
+    if [ $? -ne 0 ]; then
+      echo "Error: Failed to update $file"
+      exit 1
+    fi
+
+    echo "$file updated successfully."
+  else
+    echo "$file not found!"
+  fi
+done
+
+node dist/scripts/scripts/content.mjs || exit 1

.husky/pre-commit

@@ -0,0 +1,3 @@
+#!/bin/sh
+
+./.husky/post-process.sh || exit 1

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 Shu Ding
+Copyright (c) 2024 Rubix Studios
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,23 +1,140 @@
-# Nextra Docs Template 
+# Documents
 
-This is a template for creating documentation with [Nextra](https://nextra.site).
+**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.
 
-[**Live Demo →**](https://nextra-docs-template.vercel.app)
+**Demo**: [https://rubix-documents.vercel.app/](https://rubix-documents.vercel.app/)
 
-[![](.github/screenshot.png)](https://nextra-docs-template.vercel.app)
+[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Frubixvi%2Frubix-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%2Frubix-documents.vercel.app%2F&demo-image=https%3A%2F%2Fgithub.com%2Frubixvi%2Frubix-documents%2Fblob%2Fmain%2Fpublic%2Fscreens%2Fscreen-1.png)
 
-## Quick Start
+## Table of Contents
 
-Click the button to clone this repository and deploy it on Vercel:
+- [Installation](#installation)
+- [Usage](#usage)
+- [Features](#features)
+- [Contributing](#contributing)
+- [License](#license)
+- [Contact](#contact)
 
-[![](https://vercel.com/button)](https://vercel.com/new/clone?s=https%3A%2F%2Fgithub.com%2Fshuding%2Fnextra-docs-template&showOptionalTeamCreation=false)
+## Documentation
 
-## Local Development
+[https://docs.rubixstudios.com.au](https://docs.rubixstudios.com.au) **(In-Development)**
 
-First, run `pnpm i` to install the dependencies.
+## Development
 
-Then, run `pnpm dev` to start the development server and visit localhost:3000.
+### Installation
+
+1. Clone the repository:
+
+    ```bash
+    git clone https://github.com/rubixvi/rubix-documents.git
+    cd rubix-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](./public/screens/screen-1.png)
+*Main Screen*
+
+![Document Screen](./public/screens/screen-2.png)
+*Document Screen*
+
+![Document Footer](./public/screens/screen-3.png)
+*Document Footer*
+
+![Document Search](./public/screens/screen-4.png)
+*Document Search*
+
+![Main Dark Screen](./public/screens/screen-5.png)
+*Main Dark Mode Screen*
+
+![Document Dark Screen](./public/screens/screen-6.png)
+*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.
+This project is licensed under the MIT License. See the [LICENSE](./LICENSE) file for details.
+
+## Contact
+
+For support or inquiries, contact Vincent Vu [@rubixvi](https://x.com/rubixvi) on X.
+
+Rubix Studios - [https://www.rubixstudios.com.au](https://www.rubixstudios.com.au)
+
+Project: [https://github.com/rubixvi/rubix-documents](https://github.com/rubixvi/rubix-documents)