{"id":27643296,"url":"https://github.com/matrixorigin/matrixorigin.io","last_synced_at":"2026-03-01T14:32:17.039Z","repository":{"id":37629724,"uuid":"424470669","full_name":"matrixorigin/matrixorigin.io","owner":"matrixorigin","description":null,"archived":false,"fork":false,"pushed_at":"2026-02-26T11:02:05.000Z","size":207876,"stargazers_count":4,"open_issues_count":12,"forks_count":24,"subscribers_count":4,"default_branch":"main","last_synced_at":"2026-02-26T12:56:20.365Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/matrixorigin.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2021-11-04T04:22:47.000Z","updated_at":"2026-02-26T07:55:25.000Z","dependencies_parsed_at":"2022-07-12T16:34:34.230Z","dependency_job_id":"f38d24c2-d3cf-4be4-8777-f8f04a0b1e4b","html_url":"https://github.com/matrixorigin/matrixorigin.io","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/matrixorigin/matrixorigin.io","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matrixorigin%2Fmatrixorigin.io","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matrixorigin%2Fmatrixorigin.io/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matrixorigin%2Fmatrixorigin.io/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matrixorigin%2Fmatrixorigin.io/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/matrixorigin","download_url":"https://codeload.github.com/matrixorigin/matrixorigin.io/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matrixorigin%2Fmatrixorigin.io/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29970975,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-01T14:11:48.712Z","status":"ssl_error","status_checked_at":"2026-03-01T14:11:48.352Z","response_time":124,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-04-24T00:12:18.090Z","updated_at":"2026-03-01T14:32:17.001Z","avatar_url":"https://github.com/matrixorigin.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n  \u003cimg src=\"docs/assets/new-logo.png\" alt=\"MatrixOne Logo\" width=\"200\"/\u003e\n  \n  # MatrixOne Documentation\n  \n  [![Website](https://img.shields.io/badge/Website-docs.matrixorigin.cn-blue)](https://docs.matrixorigin.cn/en/)\n  [![License](https://img.shields.io/badge/License-Apache%202.0-green.svg)](LICENSE)\n  [![GitHub Stars](https://img.shields.io/github/stars/matrixorigin/matrixone)](https://github.com/matrixorigin/matrixone)\n  \n  **Official documentation repository for MatrixOne Database**\n  \n  [📖 Documentation](https://docs.matrixorigin.cn/en/) | [🚀 Quick Start](#quick-start) | [🤝 Contributing](CONTRIBUTING.md) | [💬 Discussions](https://github.com/matrixorigin/matrixone/discussions)\n  \n\u003c/div\u003e\n\n---\n\n## 📚 About\n\nThis repository contains all the source files for the **MatrixOne documentation website**. \n\n### What is MatrixOne?\n\n**MatrixOne** is a **hyperconverged cloud-edge native database** designed to consolidate transactional (TP), analytical (AP), and streaming workloads into a single system. It features:\n\n#### 🎯 Core Capabilities\n\n- **🔄 Hyper-Converged Engine**: Single database supporting OLTP, OLAP, time-series, and machine learning workloads\n- **☁️ Cloud-Edge Native**: Deploy across public clouds, private clouds, edge, and on-premises with seamless scalability\n- **⚡ Extreme Performance**: Vectorized execution engine with high-performance distributed transactions\n- **🌍 Multi-Tenancy**: Complete tenant isolation with independent resource management\n- **📊 Real-time HTAP**: Handle mixed transactional and analytical workloads with real-time consistency\n- **🔌 MySQL Compatibility**: Compatible with MySQL protocol and syntax for easy migration\n\n#### 💡 Key Benefits\n\n- **Simplify Architecture**: Replace multiple databases (MySQL, PostgreSQL, ClickHouse, etc.) with one unified system\n- **Reduce Costs**: Lower infrastructure and operational costs through consolidation\n- **Accelerate Development**: Faster development with unified data platform\n- **Ensure Consistency**: Global distributed transactions guarantee data consistency\n- **Scale Effortlessly**: Separate storage and compute for elastic scaling\n\nMatrixOne is ideal for scenarios requiring real-time data processing, large-scale analytics, multi-cloud deployment, and mixed workloads.\n\n### 🌐 Live Documentation\n\nVisit our documentation at: **[docs.matrixorigin.cn](https://docs.matrixorigin.cn/en/)**\n\n### 🐛 Found an Issue?\n\nWe appreciate your feedback! If you find any documentation issues:\n- 📝 [Create an Issue](https://github.com/matrixorigin/matrixorigin.io/issues/new) to let us know\n- 🔧 [Submit a Pull Request](https://github.com/matrixorigin/matrixorigin.io/pulls) to help fix it directly\n\n## 🚀 Quick Start\n\n### Prerequisites\n\n- Python 3.8+\n- Node.js 18+ and pnpm\n\n### Get Started\n\n```bash\n# Install dependencies\nmake install\n\n# Start development server\nmake serve\n```\n\nOpen **[http://127.0.0.1:8000](http://127.0.0.1:8000)** to preview the documentation.\n\n### Common Commands\n\n| Command | Description |\n|---------|-------------|\n| `make install` | Install all dependencies |\n| `make serve` | Start local server |\n| `make build` | Build static site |\n| `make lint` | Check code style |\n| `make lint-fix` | Auto-fix style issues |\n| `make clean` | Clean build artifacts |\n| `make check-all` | Run all checks (lint + links + SQL syntax) |\n| `make pre-commit` | Run pre-commit checks |\n| `make setup` | Complete setup (install + validate) |\n\nRun `make help` to see all available commands.\n\n## 🔍 Documentation Validation Tool\n\nThis repository includes a documentation validation tool for Dead Link, SQL syntax, and SQL execution checking.\n\n### Quick Usage (Makefile Commands)\n\n```bash\n# 🔗 Dead Link Checking\nmake check-links                    # Check all files\nmake check-links-changed            # Check changed files only\nmake check-links-file FILE=path    # Check specific file\n\n# 🧾 SQL Syntax Checking\nmake check-sql-syntax               # Check all files\nmake check-sql-syntax-changed       # Check changed files only\nmake check-sql-syntax-file FILE=path # Check specific file\n\n# ▶️ SQL Execution Checking (requires database)\n# Option 1: Use test database (automated start/stop)\nmake db-start                       # Start test database\nmake db-start VERSION=3.0.4        # Start specific version\nmake check-sql-exec-changed         # Check changed files\nmake check-sql-exec-file FILE=path  # Check specific file\nmake db-stop                        # Stop test database\n\n# Option 2: Use existing MatrixOne instance (skip start/stop)\nmake db-test                        # Verify database connection first\nmake check-sql-exec-changed         # Check changed files (uses existing DB)\nmake check-sql-exec-file FILE=path  # Check specific file\n# Note: If MatrixOne is already running at 127.0.0.1:6001, \n#       you can skip db-start and db-stop steps\n\n# 🔄 Comprehensive Checks\nmake check-all                      # Run all checks (lint + links + SQL syntax)\nmake validate-all                   # Full validation (lint + build + checks)\nmake pre-commit                     # Pre-commit checks (lint-fix + check-all)\n```\n\n### Alternative: Direct pnpm Commands\n\nYou can also use pnpm commands directly:\n\n```bash\n# 🔗 Dead Link 检测\npnpm run check:links:file docs/MatrixOne/xxx.md      # 单文件\npnpm run check:links:changed                          # 变更文件\n\n# 🧾 SQL 语法检测\npnpm run check:sql-syntax:file docs/MatrixOne/xxx.md # 单文件\npnpm run check:sql-syntax:changed                     # 变更文件\n\n# ▶️ SQL 执行检测\n# 选项 1: 使用测试数据库（自动启动/停止）\npnpm run db:start                                     # 启动测试数据库\npnpm run db:start 3.0.4                               # 启动指定版本\npnpm run check:sql-exec:file docs/MatrixOne/xxx.md   # 单文件\npnpm run check:sql-exec:changed                       # 变更文件\npnpm run db:stop                                      # 停止测试数据库\n\n# 选项 2: 使用已有的 MatrixOne 实例（跳过启动/停止）\npnpm run db:test                                       # 先验证数据库连接\npnpm run check:sql-exec:changed                       # 检查变更文件（使用已有数据库）\n# 注意: 如果 MatrixOne 已在 127.0.0.1:6001 运行，\n#       可以跳过 db:start 和 db:stop 步骤\n```\n\n💡 For more details, see [Documentation Validation Tool Guide](scripts/doc-validator/README.md)\n\n## 📝 Development Workflow\n\n### Initial Setup\n\n```bash\n# 1. Clone the repository\ngit clone https://github.com/matrixorigin/matrixorigin.io.git\ncd matrixorigin.io\n\n# 2. Install dependencies\nmake install\n\n# 3. Validate setup\nmake setup\n```\n\n### Daily Development Workflow\n\n#### Step 1: Make Changes\nEdit documentation files in `docs/MatrixOne/` directory.\n\n#### Step 2: Preview Locally\n```bash\nmake serve\n# Open http://127.0.0.1:8000 in your browser to preview\n```\n\n#### Step 3: Run Pre-commit Checks\nBefore committing, run comprehensive checks:\n\n```bash\nmake pre-commit\n```\n\nThis command automatically:\n- ✅ Auto-fixes linting issues (punctuation, markdown style)\n- ✅ Checks linting compliance\n- ✅ Checks dead links in changed files\n- ✅ Checks SQL syntax in changed files\n\n#### Step 4: (Optional) Full Validation\nFor thorough validation before pushing:\n\n```bash\nmake validate-all\n```\n\nThis includes:\n- Linting checks\n- Build test (ensures site builds correctly)\n- Dead link checks\n- SQL syntax checks\n\n#### Step 5: Commit Changes\n```bash\ngit add .\ngit commit -m \"Your commit message\"\n```\n\n#### Step 6: (Optional) Test SQL Execution\nIf your changes include SQL examples, test their execution:\n\n**Option A: Use Test Database (Recommended for CI/CD)**\n```bash\n# Start test database\nmake db-start\n\n# Check SQL execution in changed files\nmake check-sql-exec-changed\n\n# Stop test database\nmake db-stop\n```\n\n**Option B: Use Existing MatrixOne Instance**\nIf you already have MatrixOne running (locally or remotely), you can skip the start/stop steps:\n\n```bash\n# Check if your database is accessible\nmake db-test\n# If successful, you can directly run:\nmake check-sql-exec-changed\n# No need to start/stop database\n```\n\n\u003e **💡 Using Existing Database**: \n\u003e - If MatrixOne is already running at `127.0.0.1:6001` with user `root` and password `111`, you can skip `make db-start` and `make db-stop`\n\u003e - Use `make db-status` to check database status\n\u003e - Use `make db-test` to verify database connection\n\u003e - The validation tools will automatically connect to your existing database\n\n#### Step 7: Push to Remote\n```bash\ngit push\n```\n\n### Quick Reference\n\n| Task | Command | Notes |\n|------|---------|-------|\n| **Setup** | | |\n| Setup project | `make setup` | Install + validate |\n| **Development** | | |\n| Start dev server | `make serve` | Preview at http://127.0.0.1:8000 |\n| **Validation** | | |\n| Pre-commit check | `make pre-commit` | Auto-fix + all checks |\n| Run all checks | `make check-all` | Lint + links + SQL syntax |\n| Full validation | `make validate-all` | Includes build test |\n| Check specific file | `make check-links-file FILE=path` | Replace `path` with file path |\n| **Database** | | |\n| Check database status | `make db-status` | See if database is running |\n| Test connection | `make db-test` | Verify database accessibility |\n| Start test database | `make db-start` | Start test environment |\n| Start specific version | `make db-start VERSION=3.0.4` | Use specific MatrixOne version |\n| Stop database | `make db-stop` | Stop test environment |\n| **SQL Execution** | | |\n| Check SQL execution | `make check-sql-exec-changed` | Requires running database |\n\n### Workflow Tips\n\n1. **Quick Check Before Commit**: Use `make pre-commit` - it's the fastest way to ensure your changes are ready\n2. **Using Existing Database**: If you have MatrixOne running, check with `make db-test` first, then skip start/stop steps\n3. **Check Specific Files**: Use `FILE=path/to/file.md` parameter for targeted checks\n4. **Full Validation**: Run `make validate-all` before important commits or PRs\n\n\u003e 💡 **Tip**: For more detailed usage and advanced options, see [Documentation Validation Tool Guide](scripts/doc-validator/README.md).\n\n## 🤝 Contributing\n\nWe welcome contributions! See [Contributing Guide](CONTRIBUTING.md) for details.\n\n## 📜 License\n\nApache License 2.0 - see [LICENSE](LICENSE) for details.\n\n---\n\n\u003cdiv align=\"center\"\u003e\n  \n  **Built with ❤️ by the MatrixOne Team**\n  \n  ⭐ **Star us on GitHub!** ⭐\n  \n  [Website](https://www.matrixorigin.io) • [Documentation](https://docs.matrixorigin.cn/en/) • [GitHub](https://github.com/matrixorigin/matrixone) • [Community](https://matrixorigin.io/community)\n  \n\u003c/div\u003e","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmatrixorigin%2Fmatrixorigin.io","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmatrixorigin%2Fmatrixorigin.io","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmatrixorigin%2Fmatrixorigin.io/lists"}