feat: 初始化 vuepress项目

fd63e6a9 · 无尘 · a81a9be3 · fd63e6a9 · fd63e6a9 · fd63e6a9
Commit fd63e6a9 authored Jan 05, 2021 by 无尘
10 changed files
--- a/.gitignore
+++ b/.gitignore
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# TypeScript v1 declaration files
+typings/
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+
+# next.js build output
+.next
--- a/.vuepress/config.js
+++ b/.vuepress/config.js
+/*
+ * @Descripttion: 当前组件信息
+ * @version: 1.0.0
+ * @Author: 无尘
+ * @Date: 2021-01-05 15:46:59
+ * @LastEditors: 无尘
+ * @LastEditTime: 2021-01-05 16:01:17
+ */
+const sidebarConfig = require('../config/sidebars')
+
+module.exports = {
+  title: "前端知识库",
+  description: "前端知识库",
+  // 注入到当前页面的 HTML <head> 中的标签
+  head: [
+    ["link", { rel: "icon", href: "/favicon.ico" }], // 增加一个自定义的 favicon(网页标签的图标)
+  ],
+  // base: '/', // 这是部署到github相关的配置
+  markdown: {
+    lineNumbers: true, // 代码块显示行号
+  },
+  themeConfig: {
+    nav: [
+      { text: "主页", link: "/" },
+      { text: "简介", link: "/guide/" },
+      { text: "关于", link: "/about/" }
+    ],
+    sidebar: sidebarConfig,
+  },
+};
\ No newline at end of file
--- a/.vuepress/public/favicon.ico
+++ b/.vuepress/public/favicon.ico
--- a/.vuepress/public/logo.png
+++ b/.vuepress/public/logo.png
--- a/.vuepress/styles/palette.styl
+++ b/.vuepress/styles/palette.styl
--- a/README.md
+++ b/README.md
+---
+home: true
+heroImage: /logo.png
+actionText: 快速上手 →
+actionLink: /guide/
+features:
+- title: 简洁至上
+  details: 以 Markdown 为中心的项目结构，以最少的配置帮助你专注于写作。
+- title: Vue驱动
+  details: 享受 Vue + webpack 的开发体验，在 Markdown 中使用 Vue 组件，同时可以使用 Vue 来开发自定义主题。
+- title: 高性能
+  details: VuePress 为每个页面预渲染生成静态的 HTML，同时在页面被加载的时候，将作为 SPA 运行。
+
+footer: MIT Licensed | Copyright © 2019-present fairyly 
+---
+
+
+## 简介
+
+>本文档使用 `VuePress 1.x` 搭建   
+```
+# 安装
+yarn global add vuepress@next # 或者：npm install -g vuepress@next
+
+# 新建一个 markdown 文件
+echo '# Hello VuePress!' > README.md
+
+# 开始写作
+vuepress dev .
+
+# 构建静态文件
+vuepress build .
+```
+
--- a/about/README.md
+++ b/about/README.md
+# 文档简介
+
+VuePress 由两部分组成：第一部分是一个极简静态网站生成器 (opens new window)，它包含由 Vue 驱动的主题系统和插件 API，另一个部分是为书写技术文档而优化的默认主题，它的诞生初衷是为了支持 Vue 及其子项目的文档需求。
+
+每一个由 VuePress 生成的页面都带有预渲染好的 HTML，也因此具有非常好的加载性能和搜索引擎优化（SEO）。同时，一旦页面被加载，Vue 将接管这些静态内容，并将其转换成一个完整的单页应用（SPA），其他的页面则会只在用户浏览到的时候才按需加载。
+
+## 参考
+
+- [vuepress](https://www.vuepress.cn/guide/)
\ No newline at end of file
--- a/config/sidebars.js
+++ b/config/sidebars.js
+/*
+ * @Descripttion: 当前组件信息
+ * @version: 1.0.0
+ * @Author: 无尘
+ * @Date: 2021-01-05 15:48:15
+ * @LastEditors: 无尘
+ * @LastEditTime: 2021-01-05 15:53:14
+ */
+module.exports = {
+  '/guide/': [
+    ''     /* /guide/ */
+  ],
+  '/about/': [
+    ''     /* /guide/ */
+  ],
+  
+};
\ No newline at end of file
--- a/guide/README.md
+++ b/guide/README.md
+<!--
+ * @Descripttion: 当前组件信息
+ * @version: 1.0.0
+ * @Author: 无尘
+ * @Date: 2021-01-05 15:48:27
+ * @LastEditors: 无尘
+ * @LastEditTime: 2021-01-05 16:05:31
+-->
+# 介绍
+
+> vuepress 搭建一个前端知识库的项目；
+
+
+## 1.文档
+
+
+## 2.
\ No newline at end of file
--- a/package.json
+++ b/package.json
+{
+  "name": "front-vuepress",
+  "version": "1.0.0",
+  "description": "front-vuepress",
+  "main": "index.js",
+  "scripts": {
+    "docs:dev": "vuepress dev",
+    "docs:build": "vuepress build"
+  },
+  "repository": {
+    "type": "git",
+    "url": "http://git.gicdev.com/office/front-vuepress.git"
+  },
+  "author": "fairyly",
+  "license": "MIT",
+  "devDependencies": {
+    "vuepress": "^1.8.0"
+  }
+}