Skip to content

DGP-Studio/Snap.Hutao.Docs

Repository files navigation

Snap.Hutao.Docs

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.

How to Run Locally

Initial Setup

Before you begin, ensure you have the following installed:

Once the prerequisites are met, follow these steps:

  1. 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
  2. Navigate to the Project Directory:

    cd Snap.Hutao.Docs
  3. Install Dependencies: We use pnpm for package management. Run the following command to install all necessary dependencies:

    pnpm install

Running the Local Server

After the setup is complete, you can start the local development server:

  1. Start the Server: In the project's root directory, run:
    pnpm run docs:dev
  2. 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.

About

Documents site for Snap Hutao project

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Contributors 15

Languages