https://github.com/xila-project/website
https://github.com/xila-project/website
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/xila-project/website
- Owner: Xila-Project
- License: apache-2.0
- Created: 2023-03-22T19:10:38.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-12-27T16:13:41.000Z (over 1 year ago)
- Last Synced: 2025-04-12T09:34:53.362Z (about 1 year ago)
- Language: HTML
- Size: 3.2 MB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Xila - Website
Welcome to the repository for the [Xila Website](https://www.xila.dev)!
This project contains all the sources and documentation for the Xila operating system, including guides, architecture references, and developer resources.
## 🚀 Features
- Built with [VitePress](https://vitepress.dev/) for fast, modern documentation
- Modular documentation structure (guides, architecture, modules, drivers, etc.)
- Integrated with [Mermaid](https://mermaid-js.github.io/) for diagrams
- Full-text search powered by [Pagefind](https://pagefind.app/)
- 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:**
```sh
npm install
```
2. **Start local development server:**
```sh
npm run docs:dev
```
3. **Build the static site:**
```sh
npm run docs:build
```
4. **Preview the built site:**
```sh
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:
```sh
npm run
```
## 🤝 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](LICENSE).