Airalogy Markdown (AIMD) Packages Monorepo

Important

This repository has moved to the Airalogy monorepo and is kept as a public archived repository for historical reference. Active development now happens at https://github.com/airalogy/airalogy.

Current package source: https://github.com/airalogy/airalogy/tree/main/packages/npm Current AIMD docs: https://airalogy.github.io/airalogy/aimd/

This repository contains the AIMD packages maintained as a single monorepo:

Package	npm	Docs	Summary
@airalogy/aimd-core		README · Site	AIMD parser, syntax definitions, and utilities
@airalogy/aimd-editor		README · Site	Monaco editor integration and Vue authoring workflows
@airalogy/aimd-renderer		README · Site	Rendering AIMD to HTML and Vue
@airalogy/aimd-recorder		README · Site	Vue UI components and styles for structured AIMD recording

AIMD Examples

Scenario examples live under examples/ and are registered in the machine-readable examples/index.json. You can preview, edit, and fill these examples on the Demo examples page.

Development

Install dependencies at the repo root:

pnpm install

Run all packages in watch mode (build on change):

pnpm dev

Run dev for a single package:

pnpm --filter @airalogy/aimd-core dev
pnpm --filter @airalogy/aimd-editor dev
pnpm --filter @airalogy/aimd-renderer dev
pnpm --filter @airalogy/aimd-recorder dev

Start the Demo dev server (visually test all packages):

pnpm dev:demo

Visit http://localhost:5188 to see the demo, which includes:

• Examples: Browse repository AIMD scenario examples and fill them in the recorder
• Core Parser: Live AIMD Markdown parsing with AST and extracted fields
• Editor: Monaco editor token definitions and theme config preview
• Renderer: Live HTML / Vue VNode rendering preview
• Recorder: AIMD CSS styles and UI component preview

Documentation

Docs are hosted under docs/ with bilingual structure:

• English: docs/en/
• Chinese: docs/zh/
• Organized by package: docs/{en|zh}/packages/*
• Embedded demo page: docs/{en|zh}/demo.md

Run docs locally:

pnpm docs:dev

Build docs:

pnpm docs:build

pnpm docs:build packages both docs and demo assets (mounted under /demo/ in the docs site).

Type-check all packages:

pnpm type-check

Build

Build all packages:

pnpm build

Build a single package:

pnpm --filter @airalogy/aimd-core build

Citation

If the AIMD packages are useful in your work, please cite the Airalogy paper:

@misc{yang2025airalogyaiempowereduniversaldata,
      title={Airalogy: AI-empowered universal data digitization for research automation},
      author={Zijie Yang and Qiji Zhou and Fang Guo and Sijie Zhang and Yexun Xi and Jinglei Nie and Yudian Zhu and Liping Huang and Chou Wu and Yonghe Xia and Xiaoyu Ma and Yingming Pu and Panzhong Lu and Junshu Pan and Mingtao Chen and Tiannan Guo and Yanmei Dou and Hongyu Chen and Anping Zeng and Jiaxing Huang and Tian Xu and Yue Zhang},
      year={2025},
      eprint={2506.18586},
      archivePrefix={arXiv},
      primaryClass={cs.AI},
      url={https://arxiv.org/abs/2506.18586},
}