XMCL Pages

This repository contains the source code of the official website of xmcl in https://xmcl.app.

It also contains the docs website of xmcl https://docs.xmcl.app

Develop the official website

Install by pnpm

pnpm i

Start local dev server

pnpm run dev

Build via static site generation

pnpm run build

I18n of website

To localize the official website, add a new locale file under the locales/ folder.

Develop official document

Make sure you clone the repo with --recurse-submodules.

If you didn't do that, please run git submodule init & `git submodule update

Install by pnpm

pnpm i

Start local dev server

pnpm run docs:dev

Build via static site generation

pnpm run docs:build

Contribute the offical document

The documents are majorly written in markdown. The files should be placed under docs/ folder.

We use vitepress as docs generator. You can refer the vitepress document for writing.

To localize the document, add new locale folder under /docs folder.