English | 简体中文

Aseprite Unofficial Documentation

aseprite-vitepress is a project that ports the official Aseprite documentation using VitePress. It has excellent multilingual support and is expanded based on the official documentation repository, making it easy to update the documentation at any time.

Clone this repository

Important

This repository contains submodules. You need to use the git clone --recurse-submodules command to clone it.

git clone --recurse-submodules https://github.com/aseprite-vitepress/aseprite-vitepress.git

Install dependencies

npm install

Add a New Language

1. Use the create script command to create a new language directory

npm run create <your language>

# Or use other package managers, such as bun
# bun run create <your language>

2. In the .vitepress/config.mts file, add the new language configuration

    locales: {
        root: { label: 'English' },
        zh: { label: '简体中文' },
        jp: { label: '日本語' },
+       <your language>: { label: 'your language' },
    },

3. In the new language folder, translate the documentation

Check for Documentation Updates

Use the check command to check if the documentation has been updated

npm run check <your language>

If there are updates, it will prompt you whether to copy the files

Do you want to copy these files? (y/n):

Developer Debugging

Use vitepress for developer debugging

npm run docs:dev

Build and Preview

Use vitepress for building and previewing

# build
npm run docs:build
# preview
npm run docs:preview

Submit PR

If the build and preview are successful, you can submit a PR.