hoa.moe

English | 中文

hoa.moe is the official website of HITSZ OpenAuto, built with Hugo and Hextra.

Note: This repository is no longer maintained. We have moved the developments to repos under HITSZ-OpenAuto. Check Backend & CI and Frontend for details.

---

Features

• Fast - Built with Hugo, the world's fastest framework for building websites.
• Responsive Layout and Dark Mode - It looks great on all devices, from mobile, tablet to desktop. Dark mode is also supported to accommodate various lighting conditions.
• Full-text Search - Built-in offline full-text search powered by FlexSearch, no additional configuration required.
• Comments - Support comments powered by giscus.
• Continuous integration - All of the documents are automatically fetched from the repositories of HITSZ OpenAuto, and updated without manual intervention.

Quick Start

Clone the repository

git clone https://github.com/HITSZ-OpenAuto/hoa-moe.git --recurse-submodules --depth=1
cd hoa-moe

Using Hugo

You need to install Hugo extended version to build the website. After installation, run:

hugo server

View your site at the URL displayed in your terminal. Press Ctrl + C to stop Hugo’s development server.

(Alternative) Using NPM

npm install
bun run dev # run the development server and watch for custom Tailwind CSS changes
bun run serve # simply run the development server
bun run build # build CSS and generate static pages
bun run build:css # build only CSS

Contributing

If you would like to contribute to the document, please refer to our contribution guide. We also welcome code contributions, especially those addressing existing issues.

License

The content on the project is licensed under the CC BY-NC-SA 4.0 License. The source code is licensed under MIT License.

Acknowledgements

• Hugo
• Hextra
• Programming VTuber Logos (addon edition), @Petrica helped us with designing the wonderful logo in homepage.