https://github.com/zhiyiyo/qmaterialwidgets-docs
https://github.com/zhiyiyo/qmaterialwidgets-docs
Last synced: 9 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/zhiyiyo/qmaterialwidgets-docs
- Owner: zhiyiYo
- License: gpl-3.0
- Created: 2023-08-31T06:27:26.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-02-18T00:36:58.000Z (almost 2 years ago)
- Last Synced: 2025-02-13T19:49:12.132Z (11 months ago)
- Language: Vue
- Homepage: https://qmaterialwidgets.vercel.app
- Size: 4.04 MB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# QMaterialWidgets-Docs
The online documentation of [QMaterialWidgets](https://github.com/zhiyiYo/QMaterialWidgets).
## Quick Start
1. Install dependencies
```shell
cd dev
npm install
```
2. Launch local server
```shell
npm run dev
```
3. Check the docs on http://127.0.0.1:8080
## How to Contribute
1. Fork this repo
2. Translate markdown docs
1. Create a new directory in `dev` named the abbreviation for the translated language, i.e `jp`
2. Copy files in `dev/docs` folder to `dev/jp` and translate `*.md` files
3. Translate config files
1. Create a new directory, i.e. `dev/.vuepress/config/jp`
2. Copy files in `config/en` to `config/jp` and translate `*.js` files
3. Import the translated config to `config/index.js`:
```js
import * as zhConfig from './zh'
import * as enConfig from './en'
import * as jpConfig from './jp' // ADDED
export const themeConfig = {
locales: {
'/': {
selectLanguageText: 'Languages',
selectLanguageName: 'English',
...enConfig,
},
'/zh/': {
selectLanguageText: '选择语言',
selectLanguageName: '简体中文',
...zhConfig,
},
/* ADDED */
'/jp/': {
selectLanguageText: '言語',
selectLanguageName: '日本語',
...jpConfig,
},
},
// Don't modify other config items
}
```
4. Add language to `dev/.vuepress/config.ts`
```js
export default defineUserConfig({
locales: {
'/': {
lang: 'English',
title: 'QMaterialWidgets',
description: "QMaterialWidgets - Material Design Components Library",
},
'/zh/': {
lang: '简体中文',
title: "QMaterialWidgets",
description: "QMaterialWidgets - Material Design 风格组件库",
},
/* ADDED */
'/jp/': {
lang: '日本語',
title: 'QMaterialWidgets',
description: "QMaterialWidgets - Material Designスタイルコンポーネントライブラリ",
},
},
// Don't modify other config items
});
```
4. Create a pull request.
## Add your project to showcase
You can open an issue and provide the information of your project like this:
```js
{
name: 'QMaterialWidgets',
description: 'Material Design 风格组件库',
cover: 'https://cdn.staticaly.com/gh/qfluentwidgets/picx-images-hosting@master/20230824/QMaterialWidgets.v1z65mb7568.webp',
url: 'https://github.com/zhiyiYo/QMaterialWidgets'
}
```
## FAQ
* **`usePageFrontmatter()` is called without provider?**
**Re:** Try `npx vp-update`