教程文档编写

greatjiang · Apr 19, 2024 · dde5b0d · dde5b0d
1 parent a231cb0
commit dde5b0d
Show file tree

Hide file tree

Showing 12 changed files with 50 additions and 35 deletions.
diff --git a/README.md b/README.md
@@ -14,7 +14,7 @@ import GreatBrick from 'greatbrick'
 app.use(GreatBrick)
 // 按需引入
 import 'greatbrick/dist/css/button.css'
-import {Button} from 'greatbrick'
-app.use(Button)
+import {GButton} from 'greatbrick'
+app.use(GButton)
 ```
 
diff --git a/components/css/main.scss b/components/css/main.scss
diff --git a/docs/.vitepress/cache/deps/_metadata.json b/docs/.vitepress/cache/deps/_metadata.json
@@ -1,31 +1,31 @@
 {
-  "hash": "2779a534",
+  "hash": "62770e55",
   "configHash": "9f7a6506",
-  "lockfileHash": "f1e1c694",
-  "browserHash": "227d45d7",
+  "lockfileHash": "02439db7",
+  "browserHash": "d8565895",
   "optimized": {
     "vue": {
       "src": "../../../../node_modules/vue/dist/vue.runtime.esm-bundler.js",
       "file": "vue.js",
-      "fileHash": "cc4854b6",
+      "fileHash": "e4cd7a33",
       "needsInterop": false
     },
     "vitepress > @vue/devtools-api": {
       "src": "../../../../node_modules/@vue/devtools-api/dist/index.js",
       "file": "vitepress___@vue_devtools-api.js",
-      "fileHash": "84f0915f",
+      "fileHash": "977e5017",
       "needsInterop": false
     },
     "vitepress > @vueuse/core": {
       "src": "../../../../node_modules/@vueuse/core/index.mjs",
       "file": "vitepress___@vueuse_core.js",
-      "fileHash": "84e0d417",
+      "fileHash": "bc15ef14",
       "needsInterop": false
     },
     "@theme/index": {
       "src": "../../../../node_modules/vitepress/dist/client/theme-default/index.js",
       "file": "@theme_index.js",
-      "fileHash": "5337282e",
+      "fileHash": "2bdebd85",
       "needsInterop": false
     }
   },

diff --git a/docs/.vitepress/config.js b/docs/.vitepress/config.js
@@ -3,21 +3,26 @@ import { defineConfig } from 'vitepress'
 // https://vitepress.dev/reference/site-config
 export default defineConfig({
   base: "/greatbrick/",
-  title: "greatbrick",
+  title: "GreatBrick",
   description: "greatbrick components",
   themeConfig: {
     // https://vitepress.dev/reference/default-theme-config
     nav: [
       { text: 'Home', link: '/' },
-      { text: 'Examples', link: '/markdown-examples' }
+      { text: '组件', link: '/components-examples' }
     ],
 
     sidebar: [
       {
-        text: 'Examples',
+        text: '开发指南',
         items: [
-          { text: 'Markdown Examples', link: '/markdown-examples' },
-          { text: 'Runtime API Examples', link: '/api-examples' }
+          { text: '安装', link: '/install' }
+        ]
+      },
+      {
+        text: '基础',
+        items: [
+          { text: '按钮', link: '/button' },
         ]
       }
     ],

diff --git a/docs/button.md b/docs/button.md
@@ -0,0 +1 @@
+# 按钮
diff --git a/docs/markdown-examples.md → docs/components-examples.md b/docs/markdown-examples.md → docs/components-examples.md
diff --git a/docs/docs.md b/docs/docs.md
@@ -0,0 +1 @@
+# 教程
diff --git a/docs/index.md b/docs/index.md
@@ -3,23 +3,20 @@
 layout: home
 
 hero:
-  name: "greatbrick"
-  text: "greatbrick components"
-  tagline: My great project tagline
+  name: "GreatBrick"
+  tagline: 基于Vue3的Admin后台管理组件库
   actions:
     - theme: brand
-      text: Markdown Examples
-      link: /markdown-examples
+      text: 快速开始
+      link: /install.md
     - theme: alt
-      text: API Examples
-      link: /api-examples
+      text: 教程文档
+      link: /button.md
 
 features:
-  - title: Feature A
-    details: Lorem ipsum dolor sit amet, consectetur adipiscing elit
-  - title: Feature B
-    details: Lorem ipsum dolor sit amet, consectetur adipiscing elit
-  - title: Feature C
-    details: Lorem ipsum dolor sit amet, consectetur adipiscing elit
+  - title: 最新技术栈
+    details: vue3、vite等最新技术栈开发
+  - title: 组件封装
+    details: 对常用功能进行组件化封装，统一维护，满足基础工作需求
 ---
 
diff --git a/docs/install.md b/docs/install.md
@@ -0,0 +1,16 @@
+# 安装
+## 1.安装组件
+```bash
+npm i greatbrick
+```
+## 2.引用组件
+```javascript
+// 全部引入
+import 'greatbrick/dist/css/index.css'
+import GreatBrick from 'greatbrick'
+app.use(GreatBrick)
+// 按需引入
+import 'greatbrick/dist/css/button.css'
+import {GButton} from 'greatbrick'
+app.use(GButton)
+```
diff --git a/examples/main.js b/examples/main.js
@@ -2,9 +2,8 @@ import { createApp } from 'vue'
 import App from './App.vue'
 
 // Bootstrap
-// import 'bootstrap/dist/css/bootstrap.min.css';
+import 'bootstrap/dist/css/bootstrap.min.css';
 // import 'bootstrap/dist/js/bootstrap.bundle.min.js';
-import '../components/css/main.scss'
 import '../components/css/index.scss'
 
 import GreatBrick from '../components/lib'

diff --git a/gulpfile.js b/gulpfile.js
@@ -1,6 +1,3 @@
-// const gulp = require('gulp')
-// const sass = require('gulp-sass')
-// const minifyCSS = require('gulp-minigy-css')
 import gulp from 'gulp'
 import dartSass from 'sass'
 import gulpSass from 'gulp-sass'

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "greatbrick",
-  "version": "0.0.4",
+  "version": "0.0.5",
   "license": "MIT",
   "homepage": "https://github.com/greatjiang/greatbrick",
   "repository": {
@@ -44,4 +44,4 @@
     "sass": "^1.75.0",
     "vite": "^5.2.0"
   }
-}
+}