Pengu Docs

Official Pengu Loader documentation, built with VitePress.

👉 https://pengu.lol

How to run?

Node.js version 18 or higher and pnpm are required to run the project.

Clone the repo:

git clone https://github.com/PenguLoader/docs

Install dependencies and start development.

pnpm i
pnpm dev

Build and preview the production.

pnpm build
pnpm preview

Help us translate the docs

First, you need to create a new folder in the docs folder. For example, vi for Vietnamese.

docs/
|__guide/ |
|__runtime-api/ | -> english docs
|__index.md |
...
|__vi/ | -> vietnamese docs

Next, copy the doc files and folders from the root of the docs folder (except the language folders) and then paste them into your language folder.

docs/
|__vi/
|__guide/
|__runtime-api/
|__index.md

Finally, add your language to the .vitepress/config.ts (see the i18n section on VitePress docs to learn more).

exportdefaultdefineConfig({
...
locales: {root: {// root englishlabel: 'English',lang: 'en',},'vi': {// added vietnameselabel: 'Tiếng Việt',lang: 'vi',link: '/vi/',}}...})

When you have finished editing the translation, push your changes to your forked repo, and then open a new Pull Request.