diff --git a/README.md b/README.md index 74a6654..c4ffa4c 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,19 @@ [![HitCount](http://hits.dwyl.io/blinkfox/typora-vue-theme.svg)](http://hits.dwyl.io/blinkfox/typora-vue-theme) [![GitHub issues](https://img.shields.io/github/issues/blinkfox/typora-vue-theme.svg)](https://github.com/blinkfox/typora-vue-theme/issues) [![GitHub license](https://img.shields.io/github/license/blinkfox/typora-vue-theme.svg)](https://github.com/blinkfox/typora-vue-theme/blob/master/LICENSE) [![GitHub forks](https://img.shields.io/github/forks/blinkfox/typora-vue-theme.svg)](https://github.com/blinkfox/typora-vue-theme/network) [![GitHub stars](https://img.shields.io/github/stars/blinkfox/typora-vue-theme.svg)](https://github.com/blinkfox/typora-vue-theme/stargazers) -这是 Typora Markdown 编辑器的 Vue 文档风格的主题。 +> 这是 Typora Markdown 编辑器的类似 Vue 文档风格的主题。 -README.md 文档 完善中... \ No newline at end of file +## 简介 + +[Typora](https://www.typora.io/)是一款支持实时预览的 Markdown 编辑器和阅读器,支持`Windows`、`macOS`、`Linux`三大平台。Typora 作为一款合格的 Markdown 编辑器,支持图片、列表、表格、代码、公式、目录等功能,同时这款软件还支持(一键)动态预览功能,让一切都变得如此干净、纯粹。并且有多种主题模板。**[typora-vue-theme](https://github.com/blinkfox/typora-vue-theme)就是参考了[Vue](https://vuejs.org/)文档风格而开发的一个 Typora 自定义主题**。 + +## 安装主题 + +1. 下载本主题中的`vue.css`文件; +2. 打开 Typora,点击“偏好设置” => “打开主题文件夹”按钮,将弹出 Typora 的主题文件夹; +3. 将下载好的`vue.css`文件放到 Typora 的主题文件夹中,并确保你的`css`文件直接位于该目录下; +4. 关闭重新打开 Typora,从菜单栏中选择 “主题” => “Vue” 即可。 + +## 效果图 + +![vue主题效果图](http://static.blinkfox.com/typora_vue_theme_01.png) \ No newline at end of file