Welcome to the official repository for the Higress website and documentation. This project is built using Astro and Starlight, featuring a modern, fast, and content-focused architecture.
- Framework: Astro v5
- Documentation Theme: Starlight
- Styling: Tailwind CSS v4
- Language: TypeScript
- Node.js (v18.17.1 or higher recommended)
- npm or yarn
-
Clone the repository:
git clone https://github.com/higress-group/higress-group.github.io.git cd higress-group.github.io -
Install dependencies:
npm install
Start the local development server:
npm run devThe site will be available at http://localhost:4321/.
To build the production version of the site:
npm run buildThis command runs necessary pre-build scripts (like fetching GitHub data) and generates the static site in the dist/ directory.
To preview the production build locally:
npm run preview/
├── public/ # Static assets (images, robots.txt, etc.)
├── src/
│ ├── components/ # Reusable UI components (buttons, dropdowns, etc.)
│ ├── container/ # Section-level layout containers (e.g., Hero section)
│ ├── content/ # Markdown/MDX content (blog posts, documentation)
│ ├── layout/ # Page layouts
│ ├── pages/ # Astro pages and routes
│ └── styles/ # Global styles and Tailwind configuration
├── agent-doc/ # Development guidelines and conventions
├── astro.config.mjs # Astro configuration
└── package.json # Project dependencies and scripts
Please refer to the documentation in the agent-doc/ directory for detailed coding standards:
- Component Conventions: Guidelines for creating and structuring new components.
- Commit Conventions: Standards for git commit messages.
We welcome contributions! Please feel free to submit a Pull Request.
- Fork the repository.
- Create your feature branch (
git checkout -b feature/AmazingFeature). - Commit your changes (
git commit -m 'feat: Add some AmazingFeature'). - Push to the branch (
git push origin feature/AmazingFeature). - Open a Pull Request.