Skip to content

Commit

Permalink
update Readme.md and gitignore
Browse files Browse the repository at this point in the history
  • Loading branch information
Kimentanm committed Dec 17, 2020
1 parent 75737a1 commit ba7a3b7
Show file tree
Hide file tree
Showing 2 changed files with 160 additions and 80 deletions.
155 changes: 148 additions & 7 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,12 +1,153 @@
# npm
package-lock.json
node_modules
######################
# Project Specific
######################
/target/**
/logs/**
/doc/db/kbw.ldb
/dist/**
/design/smart-base.ldb
/src/webapp/index.js
/docker/webapp/www/**
/docker/webapp/*.jar
rebel-remote.xml

#yarn
yarn.lock
######################
# Node
######################
/node/
node_tmp/
node_modules/
npm-debug.log.*

# vscode
.vscode
######################
# SASS
######################
.sass-cache/

######################
# Eclipse
######################
*.pydevproject
.project
.metadata
tmp/
tmp/**/*
*.tmp
*.bak
*.swp
*~.nib
local.properties
.classpath
.settings/
.loadpath
.factorypath
/src/main/resources/rebel.xml

# External tool builders
.externalToolBuilders/**

# Locally stored "Eclipse launch configurations"
*.launch

# CDT-specific
.cproject

# PDT-specific
.buildpath

######################
# Intellij
######################
.idea/
*.iml
*.iws
*.ipr
*.ids
*.orig
classes/

######################
# Visual Studio Code
######################
.vscode/

######################
# Maven
######################
/log/
/target/

######################
# Gradle
######################
.gradle/
/build/

######################
# Package Files
######################
# *.jar
*.war
*.ear
*.db

######################
# Windows
######################
# Windows image file caches
Thumbs.db

# Folder config file
Desktop.ini

######################
# Mac OSX
######################
.DS_Store
.svn

# Thumbnails
._*

# Files that might appear on external disk
.Spotlight-V100
.Trashes

######################
# Directories
######################
/bin/
/deploy/

######################
# Logs
######################
*.log

######################
# Others
######################
*.class
*.*~
*~
.merge_file*

######################
# Gradle Wrapper
######################
!gradle/wrapper/gradle-wrapper.jar

######################
# Maven Wrapper
######################
!.mvn/wrapper/maven-wrapper.jar

######################
# ESLint
######################
.eslintcache

!/lib/*.jar

# vuepress
docs/.vuepress/dist
Expand Down
85 changes: 12 additions & 73 deletions README.MD
Original file line number Diff line number Diff line change
@@ -1,99 +1,38 @@
<p align="center"><a href="https://xugaoyi.com/" target="_blank" rel="noopener noreferrer"><img width="180" src="https://cdn.jsdelivr.net/gh/xugaoyi/image_store/blog/20200409124835.png" alt="logo"></a></p>
<p align="center"><a href="https://xugaoyi.com/" target="_blank" rel="noopener noreferrer"><img width="180" src="http://img.kimen.com.cn/img/20201207164724.jpeg" alt="logo"></a></p>

<p align="center">
<a href="https://github.com/xugaoyi/vuepress-theme-vdoing/actions?query=workflow%3ACI"><img src="https://github.com/xugaoyi/vuepress-theme-vdoing/workflows/CI/badge.svg" alt="CI"></a>
<a href="https://github.com/xugaoyi/vuepress-theme-vdoing/actions?query=workflow%3AbaiduPush"><img src="https://github.com/xugaoyi/vuepress-theme-vdoing/workflows/baiduPush/badge.svg" alt="baiduPush"></a>
<a href="https://github.com/xugaoyi/vuepress-theme-vdoing/blob/master/LICENSE"><img src="https://img.shields.io/github/license/xugaoyi/vuepress-theme-vdoing
" alt="License"></a>
<a href="https://www.npmjs.com/package/vuepress-theme-vdoing"><img alt="npm" src="https://img.shields.io/npm/v/vuepress-theme-vdoing"></a>
<a href="https://github.com/xugaoyi/vuepress-theme-vdoing/stargazers"><img src="https://img.shields.io/github/stars/xugaoyi/vuepress-theme-vdoing?logo=ReverbNation&logoColor=rgba(255,255,255,.6)" alt="GitHub stars"></a>



<a href="https://github.com/xugaoyi/vuepress-theme-vdoing/blob/master/LICENSE"><img src="https://img.shields.io/github/license/xugaoyi/vuepress-theme-vdoing" alt="License"></a>
</p>

<h2 align="center">vuepress-theme-vdoing</h2>
<h2 align="center">kimen-blog</h2>

* [文档 (国内源)](https://doc.xugaoyi.com/)
* [文档 (github源)](https://xugaoyi.github.io/vuepress-theme-vdoing-doc/)
* [效果:Kimen's blog](https://xugaoyi.com/)
* [效果:Kimen's blog](https://blog.kimen.com.cn/)


## 介绍
1. 这个主题的初衷是打造一个好用的、面向程序员的`知识管理工具`
2. 轻松构建一个`结构化`的知识库,让你的知识海洋像一本本书一样清晰易读。
3. 博客功能提供一种知识的`碎片化`形态,并支持个性化博客配置。
4. `简洁高效`,以 Markdown 为中心的项目结构。内置自动化工具,以更少的配置完成更多的事。配合多维索引快速定位每个知识点。
1. 博客主题 FROM [Evan's blog](https://github.com/xugaoyi)
2. 博客分类:后端、前端和技术分享。

[**更新日志**](https://github.com/xugaoyi/vuepress-theme-vdoing/releases)

## 这个主题可以做什么?
* 案例1:[知识库兼博客站](https://xugaoyi.com/)
* 案例2:[仅博客站](https://xugaoyi.github.io/vdoing-demo-blog/)
* 案例3:[仅知识库](https://xugaoyi.github.io/vdoing-demo-repository/)
* 案例4:[文档站](https://xugaoyi.github.io/vuepress-theme-vdoing-doc/)
[**更新日志**](https://github.com/kimentanm/kimen-blog/releases)


## 快速上手

```bash
# clone the project
git clone https://github.com/xugaoyi/vuepress-theme-vdoing.git
git clone https://github.com/kimentanm/kimen-blog.git

# enter the project directory
cd vuepress-theme-vdoing
cd kimen-blog

# install dependency
npm install # or yarn install
npm install # or cnpm install or yarn install

# develop
npm run dev # or yarn dev
```
## ⚡️未来...

### [VuePress-next (VuePress v2.0)](https://github.com/vuepress/vuepress-next)
> VuePress-next with the power of Vue 3.0 and TypeScript
### [VitePress](https://github.com/vuejs/vitepress)

> * Uses Vue 3.
> * Uses vite under the hood:
> * Vue 3 tree-shaking + Rollup code splitting
>
> VuePress' little brother, built on top of vite. It's currently under a different name so that we don't over commit to the compatibility with the current VuePress ecosystem (mostly themes and plugins). We'll see how close we can get without compromising the design goals listed above. But the overall idea is that VitePress will have a drastically more minimal theming API (preferring JavaScript APIs instead of file layout conventions) and likely no plugins (all customization is done in themes).
期待 [VuePress v2.0](https://github.com/vuepress/vuepress-next) 以及 [VitePress](https://github.com/vuejs/vitepress) 的正式发布...

届时,VuePress 1.x 编译慢的缺点将得到极大的改善。我将会视情况把主题升级至 VuePress v2.0 或 VitePress,也可能两个都升级。目前(2020.10.29)来看还需要挺长一段时间才能让大家使用上基于它们的新版本,还希望大家多多 [:sparkling_heart:支持](https://doc.xugaoyi.com/pages/1b12ed/) 哟,持续关注吧~

## :sparkling_heart:支持这个项目

如果你正在使用这个项目并感觉良好,或只是想要支持我继续开发,你可以通过如下*任意* 方式支持我:

1. *Star* 并 分享这个项目 :rocket:
2. 保留主题 footer(页脚) 的主题链接 :D
3. 购买前端学习类 [电子书](https://github.com/xugaoyi/blog-gitalk-comment/wiki/Front-end-Study) Ⓤⓟ 💯
4. 通过以下二维码 一次性捐款。 我多半会买一杯 ~~咖啡~~ 茶。:tea:

谢谢! :heart:

| 微信赞赏 | 微信 | 支付宝 |
| :---: | :---: | :---: |
| <img src="https://cdn.jsdelivr.net/gh/xugaoyi/image_store/blog/20200523131533.jpg" alt="赞赏码" width=150> | <img src="https://cdn.jsdelivr.net/gh/xugaoyi/image_store/blog/20200410113708.jpg" alt="Wechat QRcode" width=150>| <img src="https://cdn.jsdelivr.net/gh/xugaoyi/image_store/blog/20200410113707.jpg" alt="Alipay QRcode" width=150> |

二维码没有正常显示?点 [这里😎](https://doc.xugaoyi.com/pages/1b12ed/)

## 致谢
:heart:感谢支持这个项目的朋友

:heart:感谢为这个项目贡献代码的朋友 → [Contributors](https://github.com/xugaoyi/vuepress-theme-vdoing/graphs/contributors)

## Vdoing官方交流群
群号:694387113

<img src="https://cdn.jsdelivr.net/gh/xugaoyi/image_store/blog/20200712122307.jpg" alt="群号:694387113" width="200">

## 许可证
[MIT](https://github.com/xugaoyi/vuepress-theme-vdoing/blob/master/LICENSE)
[MIT](https://github.com/kimentanm/kimen-blog/blob/master/LICENSE)

Copyright (c) 2019-present Kimen Tang
Copyright (c) 2020-present Kimen Tang

0 comments on commit ba7a3b7

Please sign in to comment.