mirror of
https://github.com/Tencent/tdesign-vue-next-starter.git
synced 2024-11-10 13:28:32 +08:00
chore: update docs (#305)
* fix: miss layout header * chore: update docs
This commit is contained in:
yuyang
GitHub
parent
7e40754fc1
commit
fc69c8f9eb
|
|
@ -1,97 +0,0 @@
|
||||||
<p style="display:flex; justify-content: center">
|
|
||||||
|
|
||||||
</p>
|
|
||||||
<p align="center">
|
|
||||||
<a href="https://tdesign.tencent.com/starter/vue-next/#/dashboard/base" target="_blank">
|
|
||||||
<img alt="TDesign Logo" width="200" src="https://tdesign.gtimg.com/starter/brand-logo.svg">
|
|
||||||
</a>
|
|
||||||
</p>
|
|
||||||
|
|
||||||
<p align="center">
|
|
||||||
<a href="https://nodejs.org/en/about/releases/"><img src="https://img.shields.io/node/v/vite.svg" alt="node compatility"></a>
|
|
||||||
<a href="https://github.com/Tencent/tdesign-vue-next/blob/develop/LICENSE">
|
|
||||||
<img src="https://img.shields.io/npm/l/tdesign-vue-next.svg?sanitize=true" alt="License">
|
|
||||||
</a>
|
|
||||||
</p>
|
|
||||||
|
|
||||||
### Introduction
|
|
||||||
|
|
||||||
TDesign Vue Next Starter is a TDesign-based developed with `Vue3`, `Vite2`, `Pinia`, `TypeScript`. It can be customized theme configuration, and aims to provide project out-of-the-box, configuration-style middle and background projects.
|
|
||||||
|
|
||||||
<p>
|
|
||||||
<a href="http://tdesign.tencent.com/starter/vue-next/">Live Preview</a>
|
|
||||||
·
|
|
||||||
<a href="https://tdesign.tencent.com/starter/">Documentation</a>
|
|
||||||
</p>
|
|
||||||
|
|
||||||
<img src="docs/starter.png">
|
|
||||||
|
|
||||||
### Features
|
|
||||||
|
|
||||||
- Various provided pages for develop
|
|
||||||
- Complete directory structure for develop
|
|
||||||
- Code specification configuration
|
|
||||||
- Support dark mode
|
|
||||||
- Custom theme colors
|
|
||||||
- Various space layouts
|
|
||||||
- Mock data scheme
|
|
||||||
|
|
||||||
### Usage
|
|
||||||
|
|
||||||
> Initialize project with our CLI tool `tdesign-starter-cli`
|
|
||||||
|
|
||||||
```bash
|
|
||||||
## install tdesign-starter-cli
|
|
||||||
npm i tdesign-starter-cli@latest -g
|
|
||||||
|
|
||||||
## create project
|
|
||||||
td-starter init
|
|
||||||
```
|
|
||||||
|
|
||||||
### Develop
|
|
||||||
|
|
||||||
```bash
|
|
||||||
## install dependencies
|
|
||||||
npm install
|
|
||||||
|
|
||||||
## set up
|
|
||||||
npm run dev
|
|
||||||
```
|
|
||||||
|
|
||||||
### Build
|
|
||||||
|
|
||||||
```bash
|
|
||||||
## build
|
|
||||||
npm run build
|
|
||||||
|
|
||||||
## build for test
|
|
||||||
npm run build:test
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
### Contributing Guide
|
|
||||||
|
|
||||||
We welcome contributions to our project. Create your [Issue](https://github.com/tencent/tdesign-vue-next-starter/issues/new/choose) or Submit your [Pull Request](https://github.com/Tencent/tdesign-vue-next-starter/pulls).
|
|
||||||
|
|
||||||
#### Pull Request
|
|
||||||
|
|
||||||
1. Fork it!
|
|
||||||
2. Create your branch: `git checkout -b feat/xxxx`
|
|
||||||
3. Commit: `git commit -a 'feat(project): describe'`
|
|
||||||
4. Push: `git push origin feat/xxxx`
|
|
||||||
5. New Pull Request `pull request`
|
|
||||||
|
|
||||||
#### Commit Specification
|
|
||||||
|
|
||||||
- [Angular Convention](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular)
|
|
||||||
- [Vue Style Guide](https://v3.vuejs.org/style-guide/#rule-categories)
|
|
||||||
|
|
||||||
### Compatibility
|
|
||||||
|
|
||||||
| [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png" alt="IE / Edge" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br> IE / Edge | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/firefox/firefox_48x48.png" alt="Firefox" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Firefox | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/chrome/chrome_48x48.png" alt="Chrome" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Chrome | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/safari/safari_48x48.png" alt="Safari" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Safari |
|
|
||||||
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
||||||
| Edge >=84 | Firefox >=83 | Chrome >=84 | Safari >=14.1 |
|
|
||||||
|
|
||||||
### License
|
|
||||||
|
|
||||||
The MIT License. Please see [the license file](LICENSE) for more information.
|
|
||||||
27
README.md
27
README.md
|
|
@ -17,13 +17,12 @@
|
||||||
English | [简体中文](./README-zh_CN.md)
|
English | [简体中文](./README-zh_CN.md)
|
||||||
### Introduction
|
### Introduction
|
||||||
|
|
||||||
TDesign Vue Next Starter is a TDesign-based, developed with `Vue3`, `Vite2`, `Pinia`, `TypeScript`, which can be customized theme configuration, and aims to provide project out-of-the-box, configuration-style middle and background projects .
|
TDesign Vue Next Starter is a TDesign-based developed with `Vue3`, `Vite2`, `Pinia`, `TypeScript`. It can be customized theme configuration, and aims to provide project out-of-the-box, configuration-style middle and background projects.
|
||||||
|
|
||||||
<p>
|
<p>
|
||||||
<a href="http://tdesign.tencent.com/starter/vue-next/">preview</a>
|
<a href="http://tdesign.tencent.com/starter/vue-next/">Live Preview</a>
|
||||||
·
|
·
|
||||||
<a href="https://tdesign.tencent.com/starter/">documentation</a>
|
<a href="https://tdesign.tencent.com/starter/">Documentation</a>
|
||||||
|
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
<img src="docs/starter.png">
|
<img src="docs/starter.png">
|
||||||
|
|
@ -31,22 +30,22 @@ TDesign Vue Next Starter is a TDesign-based, developed with `Vue3`, `Vite2`, `Pi
|
||||||
### Features
|
### Features
|
||||||
|
|
||||||
- Various provided pages for develop
|
- Various provided pages for develop
|
||||||
- Complete Directory Structure for develop
|
- Complete directory structure for develop
|
||||||
- Code Specification Configuration
|
- Code specification configuration
|
||||||
- Dark Mode
|
- Support dark mode
|
||||||
- Custom theme colors
|
- Custom theme colors
|
||||||
- Various space layouts
|
- Various space layouts
|
||||||
- Mock Data Scheme
|
- Mock data scheme
|
||||||
|
|
||||||
### Usage
|
### Usage
|
||||||
|
|
||||||
> init project with our CLI tool `tdesign-starter-cli`
|
> Initialize project with our CLI tool `tdesign-starter-cli`
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
## install tdesign-starter-cli
|
## install tdesign-starter-cli
|
||||||
npm i tdesign-starter-cli@latest -g
|
npm i tdesign-starter-cli@latest -g
|
||||||
|
|
||||||
## 2、create project
|
## create project
|
||||||
td-starter init
|
td-starter init
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
@ -71,9 +70,9 @@ npm run build:test
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
### Contributing
|
### Contributing Guide
|
||||||
|
|
||||||
Contributing is welcome！Create your [Issue](https://github.com/tencent/tdesign-vue-next-starter/issues/new/choose) or Submit your [Pull Request](https://github.com/Tencent/tdesign-vue-next-starter/pulls)。
|
We welcome contributions to our project. Create your [Issue](https://github.com/tencent/tdesign-vue-next-starter/issues/new/choose) or Submit your [Pull Request](https://github.com/Tencent/tdesign-vue-next-starter/pulls).
|
||||||
|
|
||||||
#### Pull Request
|
#### Pull Request
|
||||||
|
|
||||||
|
|
@ -94,6 +93,6 @@ Contributing is welcome！Create your [Issue](https://github.com/tencent/tdesign
|
||||||
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
| Edge >=84 | Firefox >=83 | Chrome >=84 | Safari >=14.1 |
|
| Edge >=84 | Firefox >=83 | Chrome >=84 | Safari >=14.1 |
|
||||||
|
|
||||||
### LICENSE
|
### License
|
||||||
|
|
||||||
[MIT](https://github.com/Tencent/tdesign-vue-next-starter/LICENSE)
|
The MIT License. Please see [the license file](LICENSE) for more information.
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue
Block a user