From 2e8b3fb89f2e6be45fda04e8743a3fa1a06653b1 Mon Sep 17 00:00:00 2001 From: blinkfox Date: Sat, 2 Jun 2018 15:24:54 +0800 Subject: [PATCH] =?UTF-8?q?=E6=96=B0=E5=A2=9E=E8=8B=B1=E6=96=87=E7=9A=84RE?= =?UTF-8?q?ADME.md=E6=96=87=E4=BB=B6?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 26 ++++++++++++++------------ README_CN.md | 26 ++++++++++++++++++++++++++ 2 files changed, 40 insertions(+), 12 deletions(-) create mode 100644 README_CN.md diff --git a/README.md b/README.md index 35e887e..c8dc005 100644 --- a/README.md +++ b/README.md @@ -2,23 +2,25 @@ [![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 文档风格的自定义主题。 +[中文](README_CN.md) -## 简介 +> This is a typora theme inspired by [Vue](http://vuejs.org/) document style. -[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 自定义主题**。 +## Introduction -## 安装主题 +[Typora](https://www.typora.io/) is a markdown editor and reader that supports real-time preview. It supports `Windows`, `macOS`, `Linux` platforms. Typora is a qualified Markdown editor that supports images, lists, tables, codes, formulas, catalogs, etc. At the same time, typora also supports (one-click) dynamic preview function, so that everything becomes so clean and pure. And there are various theme templates. **[typora-vue-theme] (https://github.com/blinkfox/typora-vue-theme) inspired by [Vue](https://vuejs.org/) document style**. -1. 下载本主题中的`vue.css`文件和包含字体的`vue`文件夹； -2. 打开 Typora，点击“**偏好设置**” => “**打开主题文件夹**”按钮，将弹出 Typora 的主题文件夹； -3. 将下载好的`vue.css`文件和包含字体的`vue`文件夹放到 Typora 的主题文件夹中； -4. 关闭并重新打开 Typora，从菜单栏中选择 “**主题**” => “**Vue**” 即可。 +## Install -## 效果图 +1. [Download](https://codeload.github.com/blinkfox/typora-vue-theme/zip/master) this theme from Github, then you can get the `vue.css` file and the `vue` folder. +2. Open typora. Click "**Open Theme Folder**" button from `Preference Panel` → `Apperance` section. +3. Put `vue.css` and `vue` folder into the opened folder, make sure your css files are directly under that directory. +4. Close and reopen Typora and select `Theme` → `Vue` from the menu bar. -![vue主题效果图1](http://static.blinkfox.com/typora_vue_theme_screen_01.png) +## Screenshots -![vue主题效果图2](http://static.blinkfox.com/typora_vue_theme_screen_02.png) +![Screenshot 1](http://static.blinkfox.com/typora_vue_theme_screen_01.png) -![vue主题效果图3](http://static.blinkfox.com/typora_vue_theme_screen_03.png) \ No newline at end of file +![Screenshot 2](http://static.blinkfox.com/typora_vue_theme_screen_02.png) + +![Screenshot 3](http://static.blinkfox.com/typora_vue_theme_screen_03.png) \ No newline at end of file diff --git a/README_CN.md b/README_CN.md new file mode 100644 index 0000000..189b8e8 --- /dev/null +++ b/README_CN.md @@ -0,0 +1,26 @@ +# typora-vue-theme + +[![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) + +[English](README.md) + +> 这是 Typora Markdown 编辑器的类似 Vue 文档风格的自定义主题。 + +## 简介 + +[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`文件和包含字体的`vue`文件夹； +2. 打开 Typora，点击“**偏好设置**” => “**打开主题文件夹**”按钮，将弹出 Typora 的主题文件夹； +3. 将下载好的`vue.css`文件和包含字体的`vue`文件夹放到 Typora 的主题文件夹中； +4. 关闭并重新打开 Typora，从菜单栏中选择 “**主题**” => “**Vue**” 即可。 + +## 效果图 + +![vue主题效果图1](http://static.blinkfox.com/typora_vue_theme_screen_01.png) + +![vue主题效果图2](http://static.blinkfox.com/typora_vue_theme_screen_02.png) + +![vue主题效果图3](http://static.blinkfox.com/typora_vue_theme_screen_03.png) \ No newline at end of file