OMNI-CORE LogoOMNI-CORE
omni-mdxomni-3D (soon)Open SourceAbout
GitHubDocumentation
OMNI-CORE

Knowledge must flow freely to shape the future.

Ecosystem

  • omni-mdx
  • omni-3D

Resources

  • Documentation
  • Interactive Playground

Legal & Open Source

  • GitHub Organization
  • Notice

TOAQ GROUP © 2024 - 2026

Released under the MIT License.

Navigation

Getting Started

  • Introduction
    • Web & Next.js
    • Python Engine
    • Build from Source
  • Syntax Guide

Web Integration

  • Next.js Integration
  • Binary AST Transfer
  • Custom Components
  • Unified & Plugins Ecosystem Integration
    • Basic App Router
    • Advanced Rendering
    • Live Client Editor

Python

  • Introduction & Core Engine
    • Basic Parsing & Traversal
    • Advanced Analysis & RAG
    • Native Qt Rendering
    • HTML & Web Rendering
    • Basic Parsing
    • Advanced Analysis
    • HTML Rendering
    • Qt Rendering

Architecture & Core

    • Design Philosophy
    • The Rendering Pipeline
    • Lexing & Tokenization
    • AST Node Design
    • Math & JSX Handling
    • Protocol Specification
    • Zero-Copy Decoding
    • Memory Lifecycle
    • WASM Bindings (Browser)
    • Node.js Native Addons
    • Python Bindings (PyO3)
  • Security
    • Benchmarks
    • Fuzzing Results
Docs
Installation
Build from Source

Building from Source

Last Updated March 22, 2026

If you want to contribute to the core engine, add custom AST nodes, or compile the binaries for a specific architecture, you can build Omni-MDX directly from the monorepo.

Prerequisites

Before building from source, ensure your system meets the following requirements:

  • Rust: Latest stable version (via rustup)
  • wasm-pack: Required for building the WebAssembly core
  • Make: For running our build automation scripts

1. Clone & Setup

Clone the repository and run the setup command from the root directory to install necessary targets:

bash
git clone https://github.com/TOAQ-oss/omni-mdx-core.git
cd omni-mdx-core

make setup

2. Compile the Engines

We use a root Makefile to orchestrate builds across different targets. You can compile the specific engine you need:

Build the Web Package

bash
make build-web

This compiles the Rust core into WebAssembly and outputs the TypeScript bindings in packages/mdx-next/.

Build the Python Package

bash
make build-python

This uses maturin to compile the PyO3 bindings and makes the module available in your local Python environment.

Boosted by omni-mdx native node

On this page

  • Prerequisites
  • 1. Clone & Setup
  • 2. Compile the Engines
Edit this page on GitHub

Caught a typo or want to improve the docs? Submitting a PR is the best way to help!