This repository contains the documentation for the Snap Hutao project. You can view the live version at https://hut.ao.
We welcome contributions to our documentation! If you're interested in helping with translations, please check our Localization Guide.
Before you begin, ensure you have the following installed:
- Node.js: Download the latest LTS version
- Git: Download Git or use a client like GitHub Desktop.
Once the prerequisites are met, follow these steps:
-
Clone the Repository: Open your terminal or command prompt and run the following command to clone this project to your local machine:
git clone https://github.com/DGP-Studio/Snap.Hutao.Docs.git
-
Navigate to the Project Directory:
cd Snap.Hutao.Docs
-
Install Dependencies: We use
pnpm
for package management. Run the following command to install all necessary dependencies:pnpm install
After the setup is complete, you can start the local development server:
- Start the Server:
In the project's root directory, run:
pnpm run docs:dev
- View the Documentation:
The server will start, and you can access the local documentation by opening your browser and navigating to
http://localhost:8080
. The site will automatically update as you make changes to the source files.