Code Monkey home page Code Monkey logo

docs's Introduction

docs

Pengu Loader Docs, built on top of VitePress.

How to run?

You need NodeJS 16+ and Yarn installed. Then clone the repo:

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

Install dependencies and start development.

yarn install
yarn dev

Build and preview the production.

yarn build
yarn 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).

export default defineConfig({
  ...
  locales: {
    root: {   // root english
      label: 'English',
      lang: 'en',
    },
    'vi': {   // added vietnamese
      label: 'Tiếng Việt',
      lang: 'vi',
      link: '/vi/',
    }
  }
  ...
})

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

docs's People

Contributors

nomi-san avatar rumi-chan avatar iilusion avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.