Contribute to the documentation

For the documentation we use VitePress. A static website generator powered by Vue. You can find the source files in the dicebear/dicebear repository in the apps/docs folder. You will also find a link to the source file of the respective page in the documentation below each page.

Requirements

• A GitHub account
• Git installed (Learn how to install Git here)
• Node.js and Npm installed

Set up locally

1. Create a fork from the dicebear/dicebear repository.

2. Clone the project:

   git clone https://github.com/<YOUR_GITHUB_USERNAME>/dicebear.git

   If you've set up SSH, you can do this instead:

   git clone git@github.com:<YOUR_GITHUB_USERNAME>/dicebear.git

3. Install dependencies:

   cd dicebear
   npm install

4. Create a build:

   npm run build

Verifying your changes

You can start the documentation locally on your computer with the following command to check your changes:

npm run dev --workspace @dicebear/docs

Open http://localhost:5173/ in your browser to see your changes.

Branching and committing

Once you are happy with the changes, create a branch so you can commit the changes.

git checkout -b <YOUR_BRANCH>

Afterwards you have to add your changes to the stage and commit them.

git add .
git commit -m "Change: <YOUR_CHANGES>"
git push origin <YOUR_BRANCH>

Creating a Pull Request

Follow these instructions to create a Pull Request.

Deployment (maintainers only)

INFO

Only maintainers with write access to the repository can deploy the website. This section is documented here for completeness.

The website (dicebear.com) is deployed manually via a GitHub Actions workflow. It can be triggered from the "Actions" tab on GitHub:

• Deploy Website — Builds the VitePress documentation site and deploys it to the CDN.