Translate Documentation

So, it took a while but I have rewritten the documentation and ported it to VuePress. I hope the structure is a bit better and a few more examples.

If you have any suggestions, please feel free to contribute! And I always need help with translating!

Structure

The new structure is quite simple. The english documentation is under the /docs/ folder.

docs
├── README.md
├── guide
│   └── README.md
├── reference
│   └── README.md

The first README.md is the Landingpage. Under /guide/ you will find the normal documentation with examples. Under /reference/ you will find some coding references, like public methods, props, events and so on.

Localization

Inside the docs folder you will find the subfolders for localization. For example zh-cn/, ja/, ru/ … and so on. I’ve already created the folders and files. So if you want to contribute you only need to translate it inside your folder.

docs
├── README.md
├── reference
│   └── README.md
└── zh-cn
    ├── README.md
    ├── guide
    │   └── README.md
    └── reference
        └── README.md

Checklist for Contributors

• Checkout develop
• Run yarn docs:dev or npm run docs:dev
• Translate Landingpage /README.md
• Translate Guide /guide/README.md
• Translate API Reference /api/README.md
• Translate config.themeConfig.locales /.vuepress/config.js
• Translate config.locales /.vuepress/config.js (description field)

Feel free to add additional languages!

[rakvium]

@apertureless I’m going to implement the Russian section.

[apertureless]

Still looking for help for translations and improvements! 🍺