update readme
This commit is contained in:
xugaoyi
parent
147beb58d5
commit
89d8f4e945
32
README.MD
32
README.MD
|
|
@ -18,13 +18,13 @@
|
|||
效果图：[vdoing主题效果图](https://xugaoyi.com/pages/d557b9a89a215d2e)
|
||||
|
||||
|
||||
## Original intention 初衷
|
||||
## Original intention
|
||||
|
||||
这个主题的初衷是打造一个 **结构化** 与 **碎片化** 并存的个人**知识库**。[详情](https://github.com/xugaoyi/vuepress-theme-vdoing-blog/issues/339)
|
||||
|
||||
> 目前功能已比较完整，但仍在不断的完善当中。如果你有什么建议欢迎提**Issues**，喜欢这个项目的欢迎点个**Star**持续关注。
|
||||
|
||||
## Introduce 介绍
|
||||
## Introduce
|
||||
|
||||
1. 根据 [VuePress](https://vuepress.vuejs.org/zh/) 的默认主题修改而成，仍以官方配置为主，追求**简洁**同时又不失**美观**。
|
||||
|
||||
|
|
@ -80,19 +80,23 @@
|
|||
|
||||
[palette.styl主题调色板使用说明](https://github.com/xugaoyi/vuepress-theme-vdoing-blog/issues/345)
|
||||
|
||||
## Start 开始
|
||||
## Start
|
||||
|
||||
```bash
|
||||
# 克隆项目后进入
|
||||
git clone https://github.com/xugaoyi/vuepress-theme-vdoing-blog
|
||||
# clone the project
|
||||
git clone https://github.com/xugaoyi/vuepress-theme-vdoing-blog.git
|
||||
|
||||
# enter the project directory
|
||||
cd vuepress-theme-vdoing-blog
|
||||
|
||||
# 安装依赖并运行开发服务
|
||||
# install dependency
|
||||
npm install # or yarn install
|
||||
|
||||
# develop
|
||||
npm run dev # or yarn dev
|
||||
```
|
||||
|
||||
## Plugin 插件
|
||||
## Plugin
|
||||
|
||||
推荐几款插件
|
||||
|
||||
|
|
@ -137,7 +141,7 @@ npm run dev # or yarn dev
|
|||
|
||||
[vuepress-plugin-baidu-tongji](https://www.npmjs.com/package/vuepress-plugin-baidu-tongji)
|
||||
|
||||
## Deploy 部署
|
||||
## Deploy
|
||||
|
||||
1. 内置 `deploy.sh` 和 [GitHub Actions](https://github.com/features/actions) 两种**自动部署**脚本，一键发布到 GitHub Pages 或 国内访问速度更快的Coding Pages。
|
||||
|
||||
|
|
@ -145,7 +149,7 @@ npm run dev # or yarn dev
|
|||
|
||||
|
||||
|
||||
## Other 其他
|
||||
## Other
|
||||
|
||||
1. **评论模块的搭建**
|
||||
|
||||
|
|
@ -179,3 +183,13 @@ npm run dev # or yarn dev
|
|||
|
||||
[在线编辑和新增文章的方法](https://github.com/xugaoyi/vuepress-theme-vdoing-blog/issues/327)
|
||||
|
||||
## Donate
|
||||
如果你觉得这个主题对你有用，可以为作者贡献一杯82年的雪碧🍸。
|
||||
| Wechat | Alipay |
|
||||
| :---: | :---: |
|
||||
| <img src="https://cdn.jsdelivr.net/gh/xugaoyi/image_store/blog/20200410113708.jpg" alt="Wechat QRcode" width=200>| <img src="https://cdn.jsdelivr.net/gh/xugaoyi/image_store/blog/20200410113707.jpg" alt="Alipay QRcode" width=200> |
|
||||
|
||||
## License
|
||||
[MIT](https://github.com/xugaoyi/vuepress-theme-vdoing-blog/blob/master/LICENSE)
|
||||
|
||||
Copyright (c) 2019-present Evan Xu
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
{
|
||||
"name": "evanblog",
|
||||
"name": "vuepress-theme-vdoing",
|
||||
"version": "1.0.0",
|
||||
"scripts": {
|
||||
"dev": "node utils/frontmatter.js && node utils/sidebar.js && vuepress dev docs",
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
The MIT License (MIT)
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2018-present, Yuxi (Evan) You
|
||||
Copyright (c) 2019-present Evan Xu
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
|
|
@ -9,13 +9,13 @@ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in
|
||||
all copies or substantial portions of the Software.
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
THE SOFTWARE.
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
|
|
|
|||
|
|
@ -1,11 +1,4 @@
|
|||
# @vuepress/theme-default
|
||||
# theme-vdoing
|
||||
|
||||
> theme-default for vuepress
|
||||
theme-vdoing for vuepress
|
||||
|
||||
## Plugins
|
||||
|
||||
The default theme has the following plugin built in:
|
||||
|
||||
- [@vuepress/plugin-active-header-links](https://github.com/vuejs/vuepress/tree/master/packages/@vuepress/plugin-active-header-links)
|
||||
- [@vuepress/plugin-google-analytics](https://github.com/vuejs/vuepress/tree/master/packages/%40vuepress/plugin-google-analytics)
|
||||
- [@vuepress/plugin-search](https://github.com/vuejs/vuepress/tree/master/packages/%40vuepress/plugin-search)
|
||||
|
|
|
|||
|
|
@ -1,39 +1,10 @@
|
|||
{
|
||||
"_args": [
|
||||
[
|
||||
"@vuepress/theme-default@1.2.0",
|
||||
"E:\\Github仓库集合\\vuepress-Evan-blog"
|
||||
]
|
||||
],
|
||||
"_development": true,
|
||||
"_from": "@vuepress/theme-default@1.2.0",
|
||||
"_id": "@vuepress/theme-default@1.2.0",
|
||||
"_inBundle": false,
|
||||
"_integrity": "sha1-MwOvIaAAMaNILtHElFCCNPVFy/E=",
|
||||
"_location": "/@vuepress/theme-default",
|
||||
"_phantomChildren": {},
|
||||
"_requested": {
|
||||
"type": "version",
|
||||
"registry": true,
|
||||
"raw": "@vuepress/theme-default@1.2.0",
|
||||
"name": "@vuepress/theme-default",
|
||||
"escapedName": "@vuepress%2ftheme-default",
|
||||
"scope": "@vuepress",
|
||||
"rawSpec": "1.2.0",
|
||||
"saveSpec": null,
|
||||
"fetchSpec": "1.2.0"
|
||||
},
|
||||
"_requiredBy": [
|
||||
"/vuepress"
|
||||
],
|
||||
"_resolved": "https://registry.npm.taobao.org/@vuepress/theme-default/download/@vuepress/theme-default-1.2.0.tgz",
|
||||
"_spec": "1.2.0",
|
||||
"_where": "E:\\Github仓库集合\\vuepress-Evan-blog",
|
||||
"name": "vuepress-theme-vdoing",
|
||||
"author": {
|
||||
"name": "Evan You"
|
||||
"name": "Evan Xu"
|
||||
},
|
||||
"bugs": {
|
||||
"url": "https://github.com/vuejs/vuepress/issues"
|
||||
"url": "https://github.com/xugaoyi/vuepress-theme-vdoing-blog/issues"
|
||||
},
|
||||
"dependencies": {
|
||||
"@vuepress/plugin-active-header-links": "^1.2.0",
|
||||
|
|
@ -46,31 +17,30 @@
|
|||
"vuepress-plugin-container": "^2.0.2",
|
||||
"vuepress-plugin-smooth-scroll": "^0.0.3"
|
||||
},
|
||||
"description": "Default theme for VuePress",
|
||||
"gitHead": "f61e2d42b4b2d9a59630f95a37fab968dcbd8b39",
|
||||
"homepage": "https://github.com/vuejs/vuepress/packages/@vuepress/theme-default#readme",
|
||||
"description": "Vdoing theme for VuePress",
|
||||
"homepage": "https://github.com/xugaoyi/vuepress-theme-vdoing-blog#readme",
|
||||
"keywords": [
|
||||
"documentation",
|
||||
"vue",
|
||||
"vuepress",
|
||||
"generator"
|
||||
"generator",
|
||||
"theme",
|
||||
"blog"
|
||||
],
|
||||
"license": "MIT",
|
||||
"main": "index.js",
|
||||
"maintainers": [
|
||||
{
|
||||
"name": "ULIVZ",
|
||||
"email": "chl814@foxmail.com"
|
||||
"name": "Evan xu",
|
||||
"email": "894072666@qq.com"
|
||||
}
|
||||
],
|
||||
"name": "@vuepress/theme-default",
|
||||
"publishConfig": {
|
||||
"access": "public"
|
||||
},
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "git+https://github.com/vuejs/vuepress.git",
|
||||
"directory": "packages/@vuepress/theme-default"
|
||||
"url": "git+https://github.com/xugaoyi/vuepress-theme-vdoing-blog.git"
|
||||
},
|
||||
"version": "1.2.0"
|
||||
"version": "1.0.0"
|
||||
}
|
||||
|
|
|
|||
Loading…
Reference in New Issue