Skip to content

Commit

Permalink
add Chinese readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Jocs committed Mar 13, 2018
1 parent 21539ed commit 3464745
Show file tree
Hide file tree
Showing 5 changed files with 65 additions and 3 deletions.
2 changes: 1 addition & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ install:
script:
#- xvfb-maybe node_modules/.bin/karma start test/unit/karma.conf.js
#- yarn run pack && xvfb-maybe node_modules/.bin/mocha test/e2e
- yarn run build
- yarn run release
branches:
only:
- master
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@

<p align="center"><img src="https://badge.fury.io/gh/jocs%2Fmarktext.svg"> <img src="https://img.shields.io/github/license/marktext/marktext.svg"> <img src="https://travis-ci.org/marktext/marktext.svg?branch=master" alt=""></p>

[中文](https://github.com/marktext/marktext/blob/master/doc/i18n/zh_cn.md)

**Mark Text** is a Markdown editor for Mac and Windows, It is a concise text editor, dedicated to improving your editing efficiency, enabling you to enjoy pleasure when you finish documents, novels and conference notes easily.

![](https://github.com/marktext/marktext/blob/master/doc/summary.jpg)
Expand Down
Binary file added doc/doutu.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
60 changes: 60 additions & 0 deletions doc/i18n/zh_cn.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
<p align="center"><img src="https://github.com/marktext/marktext/blob/master/static/logo-small.png" alt="mark text" width="100" height="100"></p>

<h1 align="center">Mark Text</h1>

<p align="center"><img src="https://badge.fury.io/gh/jocs%2Fmarktext.svg"> <img src="https://img.shields.io/github/license/marktext/marktext.svg"> <img src="https://travis-ci.org/marktext/marktext.svg?branch=master" alt=""></p>

**Mark Text** 是一款高性能的 Markdown 编辑器,运行于 Mac、Windows 和 Linux 平台。其简洁的外观,流程的运行,给您带来舒适的写作体验。

![](https://github.com/marktext/marktext/blob/master/doc/summary.jpg)

<h3 align="center">特性</h3>

- Mark Text 所输及所见,摒弃了众多 markdown 编辑器左边写作右边预览的写作方式,巧妙的将编辑和预览融为一体。
- [snabbdom](https://github.com/snabbdom/snabbdom) 作为 Mark Text 的渲染引擎,保证了极速渲染编辑页面,带来流程的书写体验。
- 支持 [CommonMark Spec](https://spec.commonmark.org/0.28/)[GitHub Flavored Markdown Spec](https://spec.commonmark.org/0.28/) 语法格式,生成的 Markdown 可以复制到任何支持 markdown 格式的社区、网站。
- 段落及行内样式快捷键提升您的编辑效率。
- 输入 HTML 和 PDF 格式文件,方便在浏览器中预览。
- 黑、白两款主题,自由切换。
- 多种编辑模式:**Source Code mode****Typewriter mode****Focus mode**

#### Source Code Mode

![](https://github.com/marktext/marktext/blob/master/doc/source-code-mode.jpg)

#### Typewriter Mode

![](https://github.com/marktext/marktext/blob/master/doc/typewriter-mode.gif)

#### Focus Mode

![](https://github.com/marktext/marktext/blob/master/doc/focus-mode.jpg)

<h3 align="center">可以斗图的 Markdown 编辑器</h3>

Mark Text 内置斗图功能,省掉了寻找「斗图」的烦恼,通过快捷键 `Cmd+/` 直接打开斗图搜索面板,你需要的有趣图片就在里面。

![](https://github.com/marktext/marktext/blob/master/doc/doutu.jpg)

<h3 align="center">下载</h3>

[Download](https://github.com/marktext/marktext/releases), 解压,然后复制到Applications 文件夹。

<h3 align="center">开发</h3>

如果你想自己打包应用,或者想打包到其他平台。

- 首先 clone 仓库到本地
- 运行 `npm install`
- 运行 `npm run build`
- 复制 app 到 Applications 文件夹,如果是 windows 系统直接点击相应软件安装。

<h3 align="center">贡献</h3>

在贡献代码或者优化文档之前,请确保阅读了[Contributing Guide](https://github.com/marktext/marktext/blob/master/.github/CONTRIBUTING.md),感谢所有为 Mark Text 做出贡献的开源爱好者们。

<h3 align="center">License</h3>

[**MIT**](https://github.com/marktext/marktext/blob/master/LICENSE).

Copyright (c) 2017-present, Jocs
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
{
"name": "marktext",
"version": "0.6.13",
"version": "0.6.14",
"author": "Jocs <[email protected]>",
"description": "Next generation markdown editor",
"license": "MIT",
"main": "./dist/electron/main.js",
"scripts": {
"build": "node .electron-vue/build.js && electron-builder",
"release": "node .electron-vue/build.js && electron-builder -mwl",
"build:dir": "node .electron-vue/build.js && electron-builder --dir",
"build:clean": "cross-env BUILD_TARGET=clean node .electron-vue/build.js",
"build:web": "cross-env BUILD_TARGET=web node .electron-vue/build.js",
Expand Down

0 comments on commit 3464745

Please sign in to comment.