LICENSE Documentation

1. Project Overview & Quickstart (inclusionAI/LICENSE) Copy Chapter

LICENSE

Open-source repository inclusionAI/LICENSE

Repository Details Copy Section

• Repository: inclusionAI/LICENSE
• Primary Language: Code

Note: High-volume repository documentation is actively indexed and synchronized by YakaAI.

2. Official Technical Reference & Guides (inclusionAI/inclusionAI.github.io) Copy Chapter

File: README.md Copy Chapter

inclusionAI Website

Official website for inclusionAI, built with Docusaurus 3.

Prerequisites Copy Chapter

• Node.js ≥ 20
• pnpm (used as the package manager)

Quick Start Copy Chapter

pnpm install
pnpm start

pnpm start launches a local dev server at http://localhost:3000 with hot-reload.

Available Commands Copy Chapter

Adding a Blog Post Copy Chapter

1. Create the post directory and file Copy Section

blog//index.mdx

2. Add required frontmatter Copy Section

---
title: "Your Post Title"
date: 2025-01-01
authors: [inclusionai]
tags: [Release, Insights]
---

Frontmatter fields:

Tag Reference Copy Section

Tags serve two purposes: they render as colored badges in the Blog listing and they route posts into dedicated sections on the Research page.

Special routing tags (case-insensitive):

Badge color palette:

Tags are matched case-insensitively for routing. Use title-case (Release, Landscape) by convention to match the badge display.

3. Add a Chinese translation (optional) Copy Section

Create the same file at:

i18n/zh/docusaurus-plugin-content-blog//index.mdx

The Chinese version needs the same frontmatter; only the body content needs to be translated.

4. Including assets Copy Section

Place images and other assets in the same directory as index.mdx:

blog//
├── index.mdx
└── assets/
    └── figure1.png

Reference them with a relative path: ``.

Adding an Author Copy Chapter

Edit blog/authors.yml:

your-handle:
  name: Your Name
  title: Your Title
  url: https://github.com/your-handle
  image_url: https://github.com/your-handle.png
  email: [email protected]

Math Support Copy Chapter

KaTeX is enabled. Use standard LaTeX syntax:

• Inline: $E = mc^2$
• Block: $$\sum_{i=1}^{n} x_i$$

i18n Copy Chapter

The site ships with English (en, default) and Simplified Chinese (zh) locales.

To extract new translation strings after adding content:

pnpm write-translations --locale zh

Deployment Copy Chapter

The site is deployed to GitHub Pages via CI. The production build is triggered by pushing to main.

To build and preview locally:

pnpm build && pnpm serve

File: static/img/landscape/README.md Copy Chapter

Landscape project logos

Drop project logo images in this folder to have them appear on the
/landscape page.

How to add a logo Copy Chapter

1. Add the image file here, e.g. static/img/landscape/aworld.png
   (PNG/SVG with a transparent background works best; square aspect ratio,
   ideally ≥ 104×104 px so it stays crisp inside the 52×52 slot).

2. Open src/data/landscape.ts and set the matching project's logo field to
   the site-root path, e.g.:

   ts Copy

   {
     name: "AWorld",
     logo: "/img/landscape/aworld.png",
   }

Until a logo is set, the page renders a dashed "Logo" placeholder box so the
slot is visually reserved.

Suggested file names Copy Chapter