瀏覽代碼

:page_facing_up:update documents

zhuzhuyule 7 年之前
父節點
當前提交
ab2577940e
共有 4 個文件被更改,包括 106 次插入7 次删除
  1. 35 2
      README.md
  2. 35 2
      doc/cn/README.md
  3. 1 1
      doc/en/Building.md
  4. 35 2
      doc/ru/README.md

+ 35 - 2
README.md

@@ -75,12 +75,45 @@ Inherit [Moeditor](https://github.com/Moeditor/Moeditor), I want to fix it appro
 # Plan To Do
 - [ ] Add Toc
 - [x] Add Hexo Title Header setting (100%)
-- [ ] Add base highlight ShortCut
+- [x] Add Editor ShortCut
 - [ ] Add history files tree
 .....
 - [x] Deploy Post
 - [ ] Add multi-editing in tabs
 
+# ShortCut
+| Key                    | Method              | explanation            |
+| :--------------------: | :------------------ | :-------------- |
+| `Tab`                  | tabAdd              | add indentation        |
+| `Shift` - `Tab`        | tabSubtract         | reduce indentation        |
+| `Ctrl` - `B`           | toggleBlod          | toggle blod        |
+| `Ctrl` - `I`           | toggleItalic        | toggle italic        |
+| `Ctrl` - `D`           | toggleDelete        | delete current line        |
+| `Ctrl` - <code>\`</code>         | toggleComment       | toggle comment        |
+| `Ctrl` - `L`           | toggleUnOrderedList | toggle unordered list    |
+| `Ctrl` - `Alt` - `L`   | toggleOrderedList   | toggle ordered list    |
+| `Ctrl` - `]`           | toggleHeader        | downgrade title        |
+| `Ctrl` - `[`           | toggleUnHeader      | upgrade title        |
+| `Ctrl` - `=`           | toggleBlockquote    | add blockquote        |
+| `Ctrl` - ` - `         | toggleUnBlockquote  | reduce blockquote        |
+| `Ctrl` - `U`           | drawLink            | add hyperlink    |
+| `Ctrl` - `Alt` - `U`   | drawImageLink       | add image       |
+| `Ctrl` - `T`           | drawTable(row col)  | add table(row column) |
+| `Ctrl` - `V`           | pasteOriginContent  | paste origin content       |
+| `Shift` - `Ctrl` - `V` | pasteContent        | auto paste content      |
+| `Alt` - `F`            | formatTables        | format tables      |
+| `Ctrl` - `N`            |         | new md document      |
+| `Ctrl` - `H`            |         | new hexo document      |
+| `Ctrl` - `O`            |         | open md document      |
+| `Ctrl` - `S`            |         | save md document      |
+| `Shift` - `Ctrl` - `S`            |         | save as      |
+| `Alt` - `Ctrl` - `S`            |         | open settings      |
+| `Ctrl` - `W`            |         | toggle write mode      |
+| `Ctrl` - `P`            |         | toggle preview mode       |
+| `Ctrl` - `R`            |         | toggle read mode       |
+
+* **tip**: In mac OS, plase replace `Ctrl` key with `Cmd` key.
+
 # Building
 ```c
 //if use Windows:
@@ -96,7 +129,7 @@ npm config set registry "https://registry.npm.taobao.org/"
 npm config set electron_mirror "https://npm.taobao.org/mirrors/electron/"
 
 git clone https://github.com/zhuzhuyule/HexoEditor.git
-npm install -g electron@1.8.1
+cd HexoEditor
 npm install
 npm start
 ```

+ 35 - 2
doc/cn/README.md

@@ -76,12 +76,45 @@
 # 计划要做的
 - [ ] 添加目录
 - [x] 添加标题头设置(100%)
-- [ ] 添加基本语法快捷键
+- [x] 添加基本语法快捷键
 - [ ] 添加历史文件树木
 .....
 - [x] 快速部署
 - [ ] 多标签编辑显示
 
+# 快捷键
+| 按键                    | 方法              | 说明            |
+| :--------------------: | :------------------ | :-------------- |
+| `Tab`                  | tabAdd              | 添加缩进        |
+| `Shift` - `Tab`        | tabSubtract         | 减少缩进        |
+| `Ctrl` - `B`           | toggleBlod          | 切换粗体        |
+| `Ctrl` - `I`           | toggleItalic        | 切换斜体        |
+| `Ctrl` - `D`           | toggleDelete        | 删除当前行       |
+| `Ctrl` - <code>\`</code>         | toggleComment       | 切换注解        |
+| `Ctrl` - `L`           | toggleUnOrderedList | 切换无序列表    |
+| `Ctrl` - `Alt` - `L`   | toggleOrderedList   | 切换有序列表    |
+| `Ctrl` - `]`           | toggleHeader        | 降级标题        |
+| `Ctrl` - `[`           | toggleUnHeader      | 升级标题        |
+| `Ctrl` - `=`           | toggleBlockquote    | 增加引用        |
+| `Ctrl` - ` - `         | toggleUnBlockquote  | 减少引用        |
+| `Ctrl` - `U`           | drawLink            | 添加超级链接    |
+| `Ctrl` - `Alt` - `U`   | drawImageLink       | 添加图片       |
+| `Ctrl` - `T`           | drawTable(row col)  | 添加表格(行 列) |
+| `Ctrl` - `V`           | pasteOriginContent  |源内容粘贴       |
+| `Shift` - `Ctrl` - `V` | pasteContent        |  智能粘贴      |
+| `Alt` - `F`            | formatTables        | 格式化表格      |
+| `Ctrl` - `N`            |         | 新建md文档      |
+| `Ctrl` - `H`            |         | 新建Hexo文档      |
+| `Ctrl` - `O`            |         | 打开md文件      |
+| `Ctrl` - `S`            |         | 保存文档      |
+| `Shift` - `Ctrl` - `S`            |         | 另存为      |
+| `Alt` - `Ctrl` - `S`            |         | 打开设置      |
+| `Ctrl` - `W`            |         | 切换写作模式      |
+| `Ctrl` - `P`            |         | 切换预览模式      |
+| `Ctrl` - `R`            |         | 切换阅读模式      |
+
+* **提示**: 在 Mac OS下, 请使用 `Cmd` 来代替 `Ctrl` .
+
 # 安装
 ```c
 //如果使用 Windows:
@@ -97,7 +130,7 @@ npm config set registry "https://registry.npm.taobao.org/"
 npm config set electron_mirror "https://npm.taobao.org/mirrors/electron/"
 
 git clone https://github.com/zhuzhuyule/HexoEditor.git
-npm install -g electron@1.8.1
+cd HexoEditor
 npm install
 npm start
 ```

+ 1 - 1
doc/en/Building.md

@@ -14,7 +14,7 @@ npm config set registry "https://registry.npm.taobao.org"
 npm config set electron_mirror "https://npm.taobao.org/mirrors/electron/"
 
 git clone https://github.com/zhuzhuyule/HexoEditor.git
-npm install -g electron@1.8.1
+cd HexoEditor
 npm install
 npm start
 ```

+ 35 - 2
doc/ru/README.md

@@ -75,12 +75,45 @@
 # В планах
 - [ ] Добавить Toc
 - [x] Добавить настройку Hexo-заголовка (100%)
-- [ ] Добавить базовую подсветку ярлыков
+- [x] Добавить базовую подсветку ярлыков
 - [ ] Добавить дерево изменений файлов
 .....
 - [x] Развертывание поста
 - [ ] Добавить мульти-редактирование во вкладках
 
+# Ярлыки
+| кнопка                    | метод              | объяснение            |
+| :--------------------: | :------------------ | :-------------- |
+| `Tab`                  | tabAdd              | add indentation        |
+| `Shift` - `Tab`        | tabSubtract         | reduce indentation        |
+| `Ctrl` - `B`           | toggleBlod          | toggle blod        |
+| `Ctrl` - `I`           | toggleItalic        | toggle italic        |
+| `Ctrl` - `D`           | toggleDelete        | delete current line        |
+| `Ctrl` - <code>\`</code>         | toggleComment       | toggle comment        |
+| `Ctrl` - `L`           | toggleUnOrderedList | toggle unordered list    |
+| `Ctrl` - `Alt` - `L`   | toggleOrderedList   | toggle ordered list    |
+| `Ctrl` - `]`           | toggleHeader        | downgrade title        |
+| `Ctrl` - `[`           | toggleUnHeader      | upgrade title        |
+| `Ctrl` - `=`           | toggleBlockquote    | add blockquote        |
+| `Ctrl` - ` - `         | toggleUnBlockquote  | reduce blockquote        |
+| `Ctrl` - `U`           | drawLink            | add hyperlink    |
+| `Ctrl` - `Alt` - `U`   | drawImageLink       | add image       |
+| `Ctrl` - `T`           | drawTable(row col)  | add table(row column) |
+| `Ctrl` - `V`           | pasteOriginContent  | paste origin content       |
+| `Shift` - `Ctrl` - `V` | pasteContent        | auto paste content      |
+| `Alt` - `F`            | formatTables        | format tables      |
+| `Ctrl` - `N`            |         | new md document      |
+| `Ctrl` - `H`            |         | new hexo document      |
+| `Ctrl` - `O`            |         | open md document      |
+| `Ctrl` - `S`            |         | save md document      |
+| `Shift` - `Ctrl` - `S`            |         | save as      |
+| `Alt` - `Ctrl` - `S`            |         | open settings      |
+| `Ctrl` - `W`            |         | toggle write mode      |
+| `Ctrl` - `P`            |         | toggle preview mode       |
+| `Ctrl` - `R`            |         | toggle read mode       |
+
+* **подсказка**: В Mac OS, plase замените ключ `Ctrl` ключом` Cmd`.
+
 # Компилирование
 ```c
 //is use Windows:
@@ -96,7 +129,7 @@ npm config set registry "https://registry.npm.taobao.org/"
 npm config set electron_mirror "https://npm.taobao.org/mirrors/electron/"
 
 git clone https://github.com/zhuzhuyule/HexoEditor.git
-npm install -g electron@1.8.1
+cd HexoEditor
 npm install
 npm start
 ```