mirror of
https://github.com/sunniejs/vue-h5-template.git
synced 2025-09-11 13:19:48 +08:00
docs: update docs
This commit is contained in:
parent
27b3e97b15
commit
3fcd0b2fea
@ -43,7 +43,7 @@ function nav() {
|
||||
function sidebarGuide() {
|
||||
return [
|
||||
{
|
||||
text: "介绍",
|
||||
text: "前言",
|
||||
collapsible: true,
|
||||
items: [
|
||||
{ text: "介绍", link: "/guide/" },
|
||||
|
@ -1,6 +1,6 @@
|
||||
# 参与编辑
|
||||
|
||||
欢迎各位有意愿参与到开源当中的朋友加入文档的编写,书写文档不仅是教会别人知识,更是用自己的表达方式概括自己所学习的知识,这对个人来说是一种不多的成长机会
|
||||
欢迎有意愿参与到开源的朋友,加入到本文档的编写,书写文档不仅是教会别人知识,更是用自己的表达方式概括自己所学习知识的一种方式,这对个人来说是不多的成长机会。
|
||||
|
||||
```js
|
||||
|
||||
|
@ -1,21 +1,21 @@
|
||||
# Vue-H5-Template
|
||||
|
||||
[Vue-H5-Template](https://github.com/sunniejs/vue-h5-template),是基于 vite + vue3 + pinia + ( Vant or Varlet or NutUI ) + viewport 适配方案 ,构建移动端开发脚手架
|
||||
[Vue-H5-Template](https://github.com/sunniejs/vue-h5-template),是基于 vite3 + vue3 + pinia + ( Vant or Varlet or NutUI ) + viewport 适配方案 ,构建移动端快速开发脚手架
|
||||
|
||||
## 特点
|
||||
|
||||
### 最新技术栈
|
||||
|
||||
- 框架选型基于当下流行的 vue + vite + ts 模式,精选社区经典的 ui 框架和 vite 插件
|
||||
- 框架选型基于当下流行的 vue + vite + ts 模式,精选社区 star 和满意度均不错的 ui 框架和 vite 插件,并时常进行更新,确保与官方文档一致
|
||||
|
||||
### 基于 TypeScript
|
||||
|
||||
- typescript 越来越被大型的 js 项目所需要,明确的类型定义可以省下不少的维护成本
|
||||
- Typescript 逐渐在各种大型的 js 项目中使用,明确的类型定义可以省下不少的维护成本
|
||||
|
||||
### 轻量级
|
||||
|
||||
- 不同于集成解决方案,尽量做到轻量不冗杂,只引入高频次、需求高的插件和清晰的示例
|
||||
- 轻装上阵,便于拓展开发
|
||||
- 不同于集成的脚手架,尽量做到轻量不冗杂,只引入高频次的插件和清晰的示例
|
||||
- 轻装上阵,便于拓展开发,减少学习成本
|
||||
|
||||
### 通俗易懂的文档
|
||||
|
||||
|
@ -2,16 +2,16 @@
|
||||
|
||||
## node 版本要求
|
||||
|
||||
推荐 14.19.0+以上的版本,毕竟 2022 年了,别掐着 12+的版本了,你也可以使用[nvm](https://github.com/nvm-sh/nvm)或[nvm-windows](https://github.com/coreybutler/nvm-windows)在同一台电脑上管理多个 node 版本
|
||||
推荐 14.19.0+以上的版本,毕竟 2022 年了,别掐着 12+的版本了,你也可以使用[nvm](https://github.com/nvm-sh/nvm)或[nvm-windows](https://github.com/coreybutler/nvm-windows)在同一台电脑上管理多个 node 版本。
|
||||
|
||||
## 包管理器
|
||||
|
||||
尽量使用 yarn 或者 pnpm,本项目仅保证在 yarn 或 pnpm 下正确运行,npm 涉及到网络环境等各种情况的限制不做过多考虑。
|
||||
尽量使用 yarn 或者 pnpm,本项目仅保证在 yarn 或 pnpm 下正确运行,npm 涉及到网络环境等各种情况的限制不做过多考虑。如要使用 npm 请不要切换淘宝镜像,会有各种奇怪的 bug。
|
||||
|
||||
## 启动项目
|
||||
|
||||
项目中包含 vue2 和 vue3 两套模版
|
||||
|
||||
如你使用的是 vue2-template,请参考[vue2 项目启动]()
|
||||
如你使用的是 vue2-template,请参考[vue2 项目启动](./vue2/start.md)
|
||||
|
||||
如你使用的是 vue3-template,请参考[vue3 项目启动]()
|
||||
如你使用的是 vue3-template,请参考[vue3 项目启动](./vue3/start.md)
|
||||
|
@ -1,6 +1,6 @@
|
||||
{
|
||||
"devDependencies": {
|
||||
"vitepress": "^1.0.0-alpha.8",
|
||||
"vitepress": "^1.0.0-alpha.10",
|
||||
"vue": "^3.2.37"
|
||||
},
|
||||
"scripts": {
|
||||
|
@ -569,10 +569,10 @@ vite@^3.0.8:
|
||||
optionalDependencies:
|
||||
fsevents "~2.3.2"
|
||||
|
||||
vitepress@^1.0.0-alpha.8:
|
||||
version "1.0.0-alpha.8"
|
||||
resolved "https://registry.yarnpkg.com/vitepress/-/vitepress-1.0.0-alpha.8.tgz#b6a3b503c2ea3ed0a44a16539849c02fa996c090"
|
||||
integrity sha512-kTRN5DCagvMqr9OjylSV9/waGg0IHrxL0hBVuJoz7ykleZq2qR02n5CaiFq5QrSB/VRBGqiVsFQzet9vJsXS8g==
|
||||
vitepress@^1.0.0-alpha.10:
|
||||
version "1.0.0-alpha.10"
|
||||
resolved "https://registry.yarnpkg.com/vitepress/-/vitepress-1.0.0-alpha.10.tgz#833763efa2b43b33c5f91a7e30649e57f3af7a2f"
|
||||
integrity sha512-RGPU+YApj2jaYplAIJUe+2qlDks9FzPX1QGK+7NdGByeCCVZg6z9eYWjjvfvA/sgCtG3yeJE/4/jCwlv4Y8bVw==
|
||||
dependencies:
|
||||
"@docsearch/css" "^3.2.1"
|
||||
"@docsearch/js" "^3.2.1"
|
||||
|
Loading…
x
Reference in New Issue
Block a user