Skip to content

HITSZ-OpenAuto/hoa-moe

Repository files navigation

Logo

hoa.moe

This is the website of HITSZ OpenAuto, built with Hugo and Hextra.

showcase

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

Install Hugo

You need to install Hugo extended version to build the website.

# Windows
winget install Hugo.Hugo.Extended

# macOS
brew install hugo

# Linux
sudo snap install hugo

Run the development server

cd hoa-moe
hugo server

Open http://localhost:1313 in your browser.

Contributing

If you would like to contribute to the document, please refer to our contribution guidelines. 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