MatGrid 🔳

Modern, Content-First, AI-Friendly Multi-dimensional Knowledge Matrix. 现代化、内容优先、对 AI 友好的多维知识矩阵框架。

English | 中文说明

MatGrid is a premium framework for building digital knowledge bases and structured documentation. The name "Mat" represents the intersection of Mathematics, Matrix, and MATLAB—reflecting a core philosophy of precision, multi-dimensionality, and engineering rigor.

• Matrix-Style UX: Minimalist Apple-inspired design with a focus on structural clarity.
• Creator Studio: A dedicated local dashboard (/studio) to manage matrices, chapters, and nodes without touching code.
• Zen Editor: Split-screen live preview with LaTeX (KaTeX) and GFM support.
• GEO Optimized: Native JSON-LD and structured data to help AI models (Perplexity, ChatGPT) traverse your knowledge matrix.
• Bento-Style Library: A beautiful homepage to showcase multiple knowledge domains.
• Zero-Config Deployment: Optimized for Vercel with automatic caching.

MatGrid is driven by a single YAML file:

• title/description: Global SEO and branding.
• ui.heroTitleSize: Adjust the landing page impact (small, medium, large, huge).
• nav: Define your header navigation links.
• logo: Choose your brand icon and text.

1. Clone & Install:

   git clone https://github.com/MatNoble/MatGrid.git
   cd MatGrid
   npm install

2. Run Dev:

   npm run dev

3. Build: Access localhost:3000/studio to start constructing your matrix.

If you've cloned MatGrid to create your own book (e.g., my-math-book), you can still pull the latest framework updates:

1. Add Upstream Remote:

   git remote add upstream https://github.com/MatNoble/MatGrid.git

2. Pull Updates:

   git fetch upstream
   git merge upstream/main

Tip: To avoid merge conflicts, try not to modify files in the src/ directory directly. Use site.yaml for configuration and keep your content in its own directory within content/.

MatNoble is a full-stack developer and mathematics enthusiast based in Shenzhen, China.

• Expertise: Web Technologies, LaTeX, Educational Tech, and Mathematical Visualization.
• Portfolio: blog.matnoble.top
• GitHub: @MatNoble

MatGrid 是一个为开发者和深度创作者打造的高品质知识架构框架。名字中的 "Mat" 融合了 Mathematics (数学)、Matrix (矩阵) 与 MATLAB 的内涵，代表了本项目追求精密、多维与工程严谨性的核心哲学。

• 矩阵美学: 汲取苹果设计语言，强调结构的清晰与排版的精密。
• 创作中心: 专属本地后台 (/studio)，支持拖拽排序、章节管理，完全脱离手动修改文件的繁琐。
• 沉浸式编辑器: 分屏实时预览，完美支持数学公式 (LaTeX) 和 GitHub 风格 Markdown。
• GEO 引擎优化: 内置 JSON-LD 结构化数据，确保你的矩阵内容能被 AI 大模型（如 Perplexity, ChatGPT）精准索引。
• 多维书架: 支持同时管理多个知识领域，适合构建个人知识库或技术文档矩阵。
• Vercel 预设: 针对 Vercel 部署进行了深度优化，开箱即用。

如果你拉取了本项目作为底座进行创作（例如创建了 my-math-book），可以通过以下方式同步 MatGrid 框架的后续更新：

1. 添���上游仓库:

   git remote add upstream https://github.com/MatNoble/MatGrid.git

2. 获取并合并更新:

   git fetch upstream
   git merge upstream/main

提示：为了减少合并冲突，建议尽量避免直接修改 src/ 目录下的核心逻辑。通过 site.yaml 进行配置，并将你的书籍内容存放在 content/ 下的独立子目录中。

全站行为通过一个简单的 YAML 文件控制：

• title/description: 站点的名称和简介，用于 SEO。
• ui.heroTitleSize: 首页大标题字号。
• nav: 顶栏导航链接配置。
• logo: 自定义品牌图标和文字。

1. 克隆并安装:

   git clone https://github.com/MatNoble/MatGrid.git
   cd MatGrid
   npm install

2. 启动开发环境:

   npm run dev

3. 开始构建: 访问 localhost:3000/studio 进入管理后台。

本项目采用 MIT License。

Built with ❤️ by MatNoble.