modified readme

huaxz1986 · Mar 22, 2016 · e896b4b · e896b4b
1 parent 8ce4eaa
commit e896b4b
Show file tree

Hide file tree

Showing 4 changed files with 32 additions and 11 deletions.
diff --git a/README.md b/README.md
@@ -1,18 +1,39 @@
 # Markdown 语法以及扩展语法（数学公式扩展、流程图扩展）
-这是一份 `markdown` 语法说明，其中使用了数学公式扩展以及流程图扩展。
 
-## 基本语法图示
-![基本语法](imgs/basic.JPG)
+## 目标
+`markdown`语法简单，非常适合做电子化笔记。本人重度记笔记，其中主要是IT类和数学类。由于`markdown`语法简单不需要考虑复杂的格式，因此使得写笔记时思维主要用于思考笔记的内容而不是格式化。
+> 本人做过的所有纸质笔记可以从网盘下载：http://pan.baidu.com/s/1boxjIOZ
 
-## 数学扩展图示
-![数学扩展](imgs/math.JPG)
-
-## 流程图扩展图示
-![流程图扩展](imgs/graph.JPG)
+目前`markdown`网上教程较多，而且有些扩展语法严重依赖于编辑器。因此本人就综合现有的资料，写出了这一份文档。其中每一条命令都经过验证并给出了例子。
 
 ## 编辑器
-配合使用的 `markdown`编辑器为`cutemarked`，可以在[`cutemarked`官网下载](https://github.com/cloose/CuteMarkEd)。官方的版本需要联网实时下载渲染字体和符号的`MathJax`引擎。你也可以使用 [我修改的版本](https://github.com/huaxz1986/CuteMarkEd.git)，我修改的版本将所有资源本地化，不需要联网。
+`markdown`的扩展语法严重依赖于`markdown`编辑器。这里我采用开源的`cutemarked`编辑器。它具有以下特点：
+
+* 完整支持`markdown`基础语法
+	![基本语法](imgs/basic.JPG)
+
+* 支持`markdown`流程图扩展
+	![流程图扩展](imgs/graph.JPG)
+
+* 支持`markdown`的数学公式扩展
+	![数学扩展](imgs/math.JPG)
+
+* 支持自动提取标题以生成导航目录
+	![cutemarked展示](imgs/total.JPG)
+
+* 支持同步转换`markdown`语法到`HTML`输出
+* 支持将文档输出成`PDF`以及`HTML`格式
+* 提供源代码，基于C++/Qt开源框架，可以在`Windows/Linux/MacOS`平台下编译运行
+
+官方提供的`cutemarked`版本有一个缺陷：依赖于网络。因为它的数学公式扩展采用`MathJax`，但是它并没有将其嵌入到软件中而是通过网络下载。
+
+本人修改了它的源码，将所需要的资源打包嵌入到软件中。这样编译生成的`cutemarked`不需要依赖网络，在离线情况下就可以完美运行。项目地址在：https://github.com/huaxz1986/markdown_documentation_chinese .
+>你也可以在百度网盘下载我编译打包好的版本（解压缩直接双击运行即可），地址：http://pan.baidu.com/s/1dEqupZ7 ,运行环境为 Win7 64bit Professional
+
+
+
+**本文档仅用于个人学习目的，未经许可不得用于商业目的，转载请注明出处**
+
+**email: [email protected]** 
 
-`cutemarked`可以自动提取标题生成导航目录。该软件可以同步实时翻译你的`markdown`笔记，方便检查语法错误。
-![cutemarked展示](imgs/total.JPG)
 
diff --git a/imgs/basic.JPG b/imgs/basic.JPG
diff --git a/imgs/graph.JPG b/imgs/graph.JPG
diff --git a/imgs/math.JPG b/imgs/math.JPG