Xila - Website

Welcome to the repository for the Xila Website!

This project contains all the sources and documentation for the Xila operating system, including guides, architecture references, and developer resources.

🚀 Features

• Built with VitePress for fast, modern documentation
• Modular documentation structure (guides, architecture, modules, drivers, etc.)
• Integrated with Mermaid for diagrams
• Full-text search powered by Pagefind
• Prettier formatting for consistent style

📦 Project Structure

src/
  guide/           # Main guides and tutorials
  architecture/    # System architecture and modules
  public/          # Static assets (images, robots.txt, etc.)
  reference/       # API and technical references
  ...

🛠️ Getting Started

1. Install dependencies:

   npm install

2. Start local development server:

   npm run docs:dev

3. Build the static site:

   npm run docs:build

4. Preview the built site:

   npm run docs:preview

📝 Available Commands

Command	Description
docs:dev	Start VitePress in development mode
docs:build	Build the static site with VitePress
docs:preview	Preview the built site locally
format:fix	Format all files using Prettier
format:check	Check formatting with Prettier
check	Run format check and build documentation

Run any command with:

npm run <command>

🤝 Contributing

Contributions are welcome! Please see the guides in src/guide/get_started/contribute.md for details on how to get started.

📄 License

This project is licensed under the terms of the MIT License.

Available Commands

The following npm scripts are available for development and maintenance:

Command	Description
docs:dev	Start VitePress in development mode
docs:build	Build the static site with VitePress
docs:preview	Preview the built site locally
format:fix	Format all files using Prettier
format:check	Check formatting with Prettier
check	Run format check and build documentation

To run a command, use:

npm run <command>