Skip to content

iamzuijiasunyou/docs-frontend

Repository files navigation

Readme

a common document frontend project 中文文档 English Document

技术选型

前端框架:Nuxt.js(Vue.js), Vuetifyjs
构建工具:Webpack
包管理器:Yarn
模块加载:ES6 规范
CSS 预处理:SASS
浏览器兼容:Chrome (推荐), Safari (推荐), Firefox (推荐)

环境配置

Node:推荐v10.16.3 及以上

Build Setup

# install dependencies
$ yarn install

# serve with hot reload at localhost:3000
$ yarn run dev

# build for production
$ yarn run build

目录结构

|- assets       样式、脚本源码、原始图片资源目录
|- components     抽象、可复用 Vue 组件目录
|- config       路由配置、语言配置、枚举配置
|- doc_dir       文档内容配置,支持多目录配置
|- layouts       页面框架布局分类目录
|- middlewave     自定义中间件目录
|- node_modules    依赖包,不纳入版本控制
|- pages        对应路由的页面类 Vue 组件目录
|- plugins       自定义插件配置目录
|- static       无需构建的静态资源目录
|- store        Vuex 配置目录
|- test        测试代码目录
|- utils        工具函数目录
|- .editorconfig   编辑器配置文件
|- .prettierrc    Prettier 配置文件
|- nuxt.config.js   Nuxt.js 项目配置文件
|- package.json    项目元数据文件

About

a common documents frontend project

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published