From 281fe6f5a379f3fd5907be0d05aa821f63f9b415 Mon Sep 17 00:00:00 2001 From: TankNee Date: Thu, 8 Jul 2021 19:05:43 +0800 Subject: [PATCH] [feat]: update readme file --- README-en_us.md | 279 +++++++++++++++++++++++++++++++++++++++++++++++ README-zh_cn.md | 278 ----------------------------------------------- README.md | 284 +++++++++++------------------------------------- 3 files changed, 342 insertions(+), 499 deletions(-) create mode 100644 README-en_us.md delete mode 100644 README-zh_cn.md diff --git a/README-en_us.md b/README-en_us.md new file mode 100644 index 0000000..508d4f8 --- /dev/null +++ b/README-en_us.md @@ -0,0 +1,279 @@ +
+

Neeto Vue

+ + logo + +

An Awesome Wiz Note Client

+ +

English | 简体中文

+ + ![GitHub Workflow Status (branch)](https://img.shields.io/github/workflow/status/TankNee/Neeto-Vue/Neeto-Vue%20Release%20Action/master?label=REALSE%20ACTION&style=for-the-badge) ![GitHub Releases](https://img.shields.io/github/downloads/TankNee/Neeto-Vue/latest/total?style=for-the-badge) ![GitHub All Releases](https://img.shields.io/github/downloads/TankNee/Neeto-Vue/total?style=for-the-badge) ![GitHub Release Date](https://img.shields.io/github/release-date/TankNee/Neeto-Vue?style=for-the-badge) ![GitHub repo size](https://img.shields.io/github/repo-size/TankNee/Neeto-Vue?style=for-the-badge) ![GitHub](https://img.shields.io/github/license/TankNee/Neeto-Vue?style=for-the-badge) + +
+ +### Introduction + +[In order to write notes, I develop a note application](https://www.tanknee.cn/2020/10/02/%E6%88%91%E4%B8%BA%E4%BA%86%E8%AE%B0%E7%AC%94%E8%AE%B0%E6%89%8B%E5%86%99%E4%BA%86%E4%B8%80%E4%B8%AA%E5%AE%A2%E6%88%B7%E7%AB%AF/) + +### Wiz Community + +Follow Wiz Community in WeChat： + +![qrcode_for_gh_wizcommunity](./screenshot/qrcode_for_gh_wizcommunity.png) + +If you intend to prompt the development of Wiz Community，join us pls！ + +### ScreenShot + +![image-20200925170200202](./screenshot/image-20200925170200202.png) + +![image-20200925170301170](./screenshot/image-20200925170301170.png) + +![image-20200925170327136](./screenshot/image-20200925170327136.png) + +### Installation + +[Releases](https://github.com/TankNee/Neeto-Vue/releases/latest) + +You are also be able to check update in Neeto-Vue Settings Dialog + +![image-20201011103144579](./screenshot/image-20201011103144579.png) + +#### Arch Linux + +Install and upgrade from [AUR](https://aur.archlinux.org/packages/neeto-vue-bin/) + +Thanks to [yjun123](https://github.com/yjun123)'s contribution. + +```bash +# AUR helper +# yay +yay -S neeto-vue-bin + +# pikaur +pikaur -S neeto-vue-bin +``` + +### Feature + +- More Beautiful + +- More Powerful + +- Lighter Size + +- Better Dark Mode In Desktop Platform + +- Export single note or whole note folder to certain path + +- Loading Animation + +- New version check + +- International, support English and Chinese(Simplified) + +- Keymap: [vditor keymap](#Change Log and Keymap) + +- Support to send note to flomo app + +- Support note lock + +### Attention + +- There's another problem with copying notes, Since I haven't handled the transfer of note resources, I don't recommend copying notes for the time being +- Image upload service only supports drag and drop upload or fill in picture link directly +- When using the wiz official image service, only the temporary address of the image will be displayed +- For the time being, only the third-party Web upload service is available. (Settings > > editor > > image upload service) please refer to：[picgo-plugin-web-uploader](https://github.com/yuki-xin/picgo-plugin-web-uploader) + - `url`: Picture upload api url + - `paramName`: POST parameter name(eg:`image`) + - `jsonPath`: Jsonpath of the return value of the image URL`(eg:data.url)` + - `customHeader`: custom request http headers,using standard JSON schema(eg: `{"key":"value"}`) + - `customBody`: custom request body, using standard JSON schema(eg: `{"key":"value"}`) + +### Change Log and Keymap + +
+Version change log + +## 2021 06 22 Update 1.0.3 + +1. fix #72，#73 +2. fix some issues of dependencies + +## 2021 01 17 Update 1.0.2 + +1. Remove the underline of links +2. Extract source plain text from note content instead of using the origin markdown text + +## 2020 12 22 Update 1.0.0 + +1. Realize the label system +2. Right click to upload pictures, which depends on picgo +3. Optimize a lot of details + +## 2020 12 22 Update 0.0.23 + +1. To achieve a simpler image upload method: right click in the editor and select the image to upload. +2. Temporarily abandon the drag upload mode. + +## 2020 12 19 Update 0.0.22 + +1. Add Chinese readme file +2. Improve the readme description +3. Add note locking function to make it easier to check notes. + +## 2020 12 17 Update 0.0.21 + +1. Add flomo API support. Set > > Service > > flomo. Then use the right-click menu in the list to send notes to flomo +2. Upgrade note editor to v3.7.1 +3. Cache key naming policy adjustment + +## 2020 12 03 Update 0.0.20 + +1. Fixed the problem that the server could not display the folder when it returned the out of order folder list + +## 2020 11 30 Update 0.0.19 + +1. Repair the export failure when there are illegal characters in the note name + +## 2020 11 27 Update 0.0.18 + +1. Export a single file to markdown +2. Export the entire folder to the specified directory in the format of markdown + +## 2020 09 27 Update 0.0.6 + +1. Better login experience +2. Optimize the interface without content +3. Optimize code logic + +## 2020 09 26 Update 0.0.5 + +1. Add GitHub to build automatically + +## 2020 09 25 Update 0.0.4 + +1. Optimize the header display in MacOS +2. Add vditor shortcut key, [shortcut key to check address]（ https://ld246.com/guide/markdown ) +3. Optimization Icon +4. Add the Save button in the lower right corner of vdtor, but the outline button in the upper right corner has not been implemented +5. Learn from wizlite to open the links in notes +6. Optimize invalid code + +## 2020 09 22 Update 0.0.3 + +1. Version updated to 0.0.3 +2. Add drag and drop image upload +3. Drag the picture directly into the editor +4. Remember to click the location of the image to be inserted first, otherwise it will be inserted directly into the place where I last clicked. I have no way to fix it for the time being +5. Fix the size of editor area +6. Add notes to modify the date display +7. Fix the problem of missing translation + +
+ +
+Keymap reference + + +[Origin Site](https://ld246.com/article/1582778815353#English) + +## English + +### Summary + +| Name | Keymap | Remarks | +| ---------------------- | --------------------- | ----------------- | +| Emoji | :/⌘ E | | +| Headings | Ctrl H / ⌘ H | see below | +| Bold | Ctrl B / ⌘ B | | +| Italic | Ctrl I / ⌘ I | | +| Strikeout | Ctrl S / ⌘ S | | +| Link | Ctrl K / ⌘ K | see below | +| Unordered List | Ctrl L / ⌘ L | see below | +| Ordered List | Ctrl O / ⌘ O | see below | +| Task List | Ctrl J / ⌘ J | see below | +| Blockquote | Ctrl ; / ⌘ ; | see below | +| Horizontal | Ctrl Shift H / ⌘ ⇧ H | | +| Code Block | Ctrl U / ⌘ U | see below | +| Inline Code | Ctrl G / ⌘ G | | +| Insert Block to Before | Ctrl Shift B / ⌘ ⇧ B | wysiwyg & ir mode | +| Insert Block to End | Ctrl Shift E / ⌘ ⇧ E | wysiwyg & ir mode | +| Table | Ctrl M / ⌘ M | see below | +| Undo | Ctrl Z / ⌘ Z | | +| Redo | Ctrl Y / ⌘ Y | | +| Hide Edit | Ctrl P / ⌘ P | sv mode | +| Fullscreen | Ctrl ' / ⌘ ' | | +| Move Block to Up | Ctrl Shift U / ⌘ ⇧ U | wysiwyg & ir mode | +| Move Block to Down | Ctrl Shift D / ⌘ ⇧ D | wysiwyg & ir mode | +| Remove | Ctrl Shift X / ⌘ ⇧ X | wysiwyg mode | +| At User | @ | | +| Mistyped | Backspace | | + +### Headings Ctrl H / ⌘ H + +| Name | Keymap | +| ------- | -------------------------------------- | +| Bigger | Ctrl + / ⌘ + | +| Smaller | Ctrl - / ⌘ - | +| H1-H6 | Ctrl Alt 1/2/3/4/5/6 / ⌘ ⌥ 1/2/3/4/5/6 | +| Menu | Ctrl H / ⌘ H | + +### Link Ctrl K / ⌘ K + +| Name | Keymap | +| --------------------- | ------------------- | +| Toggle Input and Link | Alt Enter / ⌥ Enter | +| Toggle Input | Tab | + +### List Ctrl L/O/J / ⌘ L/O/J + +| Name | Keymap | Remarks | +| ------------ | -------------------------------------------- | ----------------------------------------------------- | +| Indent | Tab Ctrl Shift I / ⌘ ⇧ I | Tab: Caret must be at Zero | +| Unindent | Shift Tab / ⇧ Tab Ctrl Shift O / ⌘ ⇧ O Enter | Shift Tab / ⇧ Tab: Caret must be at Zero Enter: Empty | +| Toggle Check | Ctrl Shift J / ⌘ ⇧ J | Task List | + +### Blockquote Ctrl ; / ⌘ ; + +| Name | Keymap | Remarks | +| ----------------------- | -------------------------- | ----------------------------------------------------- | +| Move Caret to Top Start | Ctrl Alt Enter / ⌘ ⌥ Enter | wysiwyg mode | +| Move Caret to Top End | Alt Enter / ⌥ Enter | wysiwyg mode | +| Insert Blockquote | Ctrl Shift : / ⌘ ⇧ : > | Ctrl Shift : / ⌘ ⇧ :: Block Element >: Inline Element | +| Toggle Blockquote | Ctrl ; / ⌘ ; | | + +### Code Block Ctrl U / ⌘ U + +| Name | Keymap | +| --------------------------- | ------------------- | +| Toggle Input and Code Block | Alt Enter / ⌥ Enter | +| Hide Edit | Escape | +| Select all Code Block | Ctrl A / ⌘ A | + +### Table Ctrl M / ⌘ M + +| Name | Keymap | +| --------------------------- | --------------------------- | +| Insert 1 above | Ctrl + / ⌘ ⇧ F | +| Insert 1 below | Ctrl + / ⌘ + | +| Delete Row | Ctrl - / ⌘ - | +| Insert 1 left | Ctrl Shift + / ⌘ ⇧ G | +| Insert 1 right | Ctrl Shift + / ⌘ ⇧ + | +| Delete Column | Ctrl Shift - / ⌘ ⇧ - | +| Left Alignment | Ctrl Shift L / ⌘ ⇧ L | +| Center Alignment | Ctrl Shift C / ⌘ ⇧ C | +| Right Alignment | Ctrl Shift R / ⌘ ⇧ R | +| Move Caret to Input | Alt Enter / ⌥ Enter | +| Toggle Input | Tab | +| Move Caret to Previous Cell | Shift Tab / ⇧ Tab Backspace | +| Move Caret to Next Cell | Tab | + +
+ +### License + +Copyright © 2021 [tanknee ](https://github.com/TankNee).
+This project is [MIT](https://github.com/TankNee/Neeto-Vue/blob/master/LICENSE) licensed. + +[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2FTankNee%2FNeeto-Vue.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2FTankNee%2FNeeto-Vue?ref=badge_large) diff --git a/README-zh_cn.md b/README-zh_cn.md deleted file mode 100644 index a8a936f..0000000 --- a/README-zh_cn.md +++ /dev/null @@ -1,278 +0,0 @@ -
-

Neeto Vue

- - logo - -

又一个设计优良的为知笔记客户端

- -

English | 简体中文

- - ![GitHub Workflow Status (branch)](https://img.shields.io/github/workflow/status/TankNee/Neeto-Vue/Neeto-Vue%20Release%20Action/master?label=REALSE%20ACTION&style=for-the-badge) ![GitHub Releases](https://img.shields.io/github/downloads/TankNee/Neeto-Vue/latest/total?style=for-the-badge) ![GitHub All Releases](https://img.shields.io/github/downloads/TankNee/Neeto-Vue/total?style=for-the-badge) ![GitHub Release Date](https://img.shields.io/github/release-date/TankNee/Neeto-Vue?style=for-the-badge) ![GitHub repo size](https://img.shields.io/github/repo-size/TankNee/Neeto-Vue?style=for-the-badge) ![GitHub](https://img.shields.io/github/license/TankNee/Neeto-Vue?style=for-the-badge) - -
- -### 介绍 - -[为了记笔记，我写了一个笔记客户端](https://www.tanknee.cn/2020/10/02/%E6%88%91%E4%B8%BA%E4%BA%86%E8%AE%B0%E7%AC%94%E8%AE%B0%E6%89%8B%E5%86%99%E4%BA%86%E4%B8%80%E4%B8%AA%E5%AE%A2%E6%88%B7%E7%AB%AF/) - -### 为知社区 - -关注为知社区订阅号，获取最新信息： - -![qrcode_for_gh_wizcommunity](./screenshot/qrcode_for_gh_wizcommunity.png) - -如果你愿意促进社区发展，那[加入我们](https://github.com/altairwei/WizNotePlus/blob/master/加入我们)吧！ - -### 软件截图 - -![image-20200925170200202](./screenshot/image-20200925170200202.png) - -![image-20200925170301170](./screenshot/image-20200925170301170.png) - -![image-20200925170327136](./screenshot/image-20200925170327136.png) - -### 下载 - -[发行版](https://github.com/TankNee/Neeto-Vue/releases/latest) - -您也可以在设置弹窗中检查笔记的最新版本 - -![image-20201011103144579](./screenshot/image-20201011103144579.png) - -#### Arch Linux - -可以通过 [AUR](https://aur.archlinux.org/packages/neeto-vue-bin/) 安装 - -感谢[yjun123](https://github.com/yjun123)。 - -```bash -# AUR helper -# yay -yay -S neeto-vue-bin - -# pikaur -pikaur -S neeto-vue-bin -``` - -### 特色 - -- 更加舒适的设计 - -- 更加实用的功能 - -- 相对更小的空间占用 - -- 更好的黑暗模式 - -- 方便的笔记层级展示 - -- 加载动画 - -- 新版本检测 - -- 国际化，支持简体中文与英文 - -- 快捷键: [vditor 快捷键](#更新记录与快捷键) - -- 支持将笔记发送到 Flomo 浮墨 - -- 支持笔记锁定模式 - -### 注意事项 - -- 移动笔记时还存在一些问题。暂时不可用。 -- 图片上传还只支持拖拽上传和直接填写图片链接 -- 使用为知官方图片服务时只会显示图片的临时地址 -- 图片上传服务暂时只可用第三方 web 上传服务。(设置 >> 编辑器 >> 图片上传服务)参数填写方式请参照：[picgo-plugin-web-uploader](https://github.com/yuki-xin/picgo-plugin-web-uploader) - - `url`: 图床上传 API 地址 - - `paramName`: POST 参数名(eg:`image`) - - `jsonPath`: 图片 URL 所在返回值的`JsonPath(eg:data.url)` - - `customHeader`: 自定义请求头 标准 JSON(eg: `{"key":"value"}`) - - `customBody`: 自定义 Body 标准 JSON(eg: `{"key":"value"}`) - -### 更新记录与快捷键 - -
-版本变更记录 - -## 2021 06 22 Update 1.0.3 - -1. 修复 #72，#73 -2. 修复依赖的一些问题 - -## 2021 01 17 Update 1.0.2 - -1. 去除超链接的下划线 -2. 文章目录识别时自动提取标题的内容而不是使用Markdown原文本 - -## 2020 12 22 Update 1.0.0 - -1. 实现标签系统 -2. 实现图片右键上传，此功能依赖PicGo -3. 大量细节优化 - -## 2020 12 22 Update 0.0.23 - -1. 实现更简单的图片上传方式：在编辑器中右键选择图片上传。 -2. 暂时废弃拖拽上传的方式。 - -## 2020 12 19 Update 0.0.22 - -1. 添加中文 Readme 文件 -2. 完善 readme 描述 -3. 添加笔记锁定功能，实现更方便的笔记查阅。 - -## 2020 12 17 Update 0.0.21 - -1. 添加 Flomo Api 的支持。 设置 >> 服务 >> 浮墨. 然后在列表中使用右键菜单即可将笔记发送到 Flomo -2. 笔记编辑器升级到 v3.7.1 -3. 缓存 key 命名策略调整 - -## 2020 12 03 Update 0.0.20 - -1. 修复服务器返回乱序文件夹列表时无法显示文件夹的问题 - -## 2020 11 30 Update 0.0.19 - -1. 修复笔记名称中带有非法字符时导出失败 - -## 2020 11 27 Update 0.0.18 - -1. 单个文件导出为 Markdown -2. 导出整个文件夹到指定目录，格式为 Markdown - -## 2020 09 27 Update 0.0.6 - -1. 实现更好的登录体验 -2. 优化无内容时的界面 -3. 优化代码逻辑 - -## 2020 09 26 Update 0.0.5 - -1. 添加 github 自动构建 - -## 2020 09 25 Update 0.0.4 - -1. 优化 macos 下的 header 显示 -2. 添加 vditor 快捷键，[快捷键查阅地址](https://ld246.com/guide/markdown) -3. 优化图标 -4. 添加 vditor 右下角的保存按钮，右上角的 outline 按钮还没有实现 -5. 借鉴 wizlite 实现笔记中的链接外部打开 -6. 优化无效代码 - -## 2020 09 22 Update 0.0.3 - -1. 版本更新至 0.0.3 -2. 添加图片的拖拽上传 - 1. 将图片直接拖入到编辑器中 - 2. 记得要先点击图片要插入的位置，否则会直接插入到上一次点击的地方，我暂时没找到办法修复 -3. 修复编辑器区域大小的问题 -4. 添加笔记修改日期的显示 -5. 修复了翻译缺失的问题 - -
- -
-快捷键指南 - -[Vditor 快捷键](https://ld246.com/article/1582778815353#%E4%B8%AD%E6%96%87) - -## 中文 - -### 通用 - -| 名称 | 快捷键 | 备注 | -| -------------- | --------------------- | ----------------- | -| 表情 | :/⌘ E | | -| 标题 | Ctrl H / ⌘ H | 参见下文 | -| 粗体 | Ctrl B / ⌘ B | | -| 斜体 | Ctrl I / ⌘ I | | -| 删除线 | Ctrl S / ⌘ S | | -| 链接 | Ctrl K / ⌘ K | 参见下文 | -| 无序列表 | Ctrl L / ⌘ L | 参见下文 | -| 有序列表 | Ctrl O / ⌘ O | 参见下文 | -| 任务列表 | Ctrl J / ⌘ J | 参见下文 | -| 引用 | Ctrl ; / ⌘ ; | 参见下文 | -| 分割线 | Ctrl Shift H / ⌘ ⇧ H | | -| 代码块 | Ctrl U / ⌘ U | 参见下文 | -| 代码 | Ctrl G / ⌘ G | | -| 元素前插入空块 | Ctrl Shift B / ⌘ ⇧ B | wysiwyg & ir 模式 | -| 元素后插入空块 | Ctrl Shift E / ⌘ ⇧ E | wysiwyg & ir 模式 | -| 表格 | Ctrl M / ⌘ M | 参见下文 | -| 撤销 | Ctrl Z / ⌘ Z | | -| 重做 | Ctrl Y / ⌘ Y | | -| 隐藏编辑器 | Ctrl P / ⌘ P | sv 模式 | -| 全屏 | Ctrl ' / ⌘ ' | | -| 向上移动块元素 | Ctrl Shift U / ⌘ ⇧ U | wysiwyg & ir 模式 | -| 向下移动块元素 | Ctrl Shift D / ⌘ ⇧ D | wysiwyg & ir 模式 | -| 移除当前元素 | Ctrl Shift X / ⌘ ⇧ X | wysiwyg 模式 | -| At 用户 | @ | | -| 错误输入 | Backspace | | - -### 标题 Ctrl H / ⌘ H - -| 名称 | 快捷键 | -| -------- | -------------------------------------- | -| 变大 | Ctrl + / ⌘ + | -| 变小 | Ctrl - / ⌘ - | -| H1-H6 | Ctrl Alt 1/2/3/4/5/6 / ⌘ ⌥ 1/2/3/4/5/6 | -| 弹出菜单 | Ctrl H / ⌘ H | - -### 链接 Ctrl K / ⌘ K - -| 名称 | 快捷键 | -| -------------------- | ------------------- | -| 输入框和元素之间切换 | Alt Enter / ⌥ Enter | -| 输入框之间切换 | Tab | - -### 列表 Ctrl L/O/J / ⌘ L/O/J - -| 名称 | 快捷键 | 备注 | -| ------------------ | -------------------------------------------- | ----------------------------------------------------- | -| 缩进 | Tab Ctrl Shift I / ⌘ ⇧ I | Tab: 光标需位于开头 | -| 反向缩进 | Shift Tab / ⇧ Tab Ctrl Shift O / ⌘ ⇧ O Enter | Shift Tab / ⇧ Tab: 光标需位于开头 Enter: 需为空列表项 | -| 完成和待办之间切换 | Ctrl Shift J / ⌘ ⇧ J | 任务列表 | - -### 引用 Ctrl ; / ⌘ ; - -| 名称 | 快捷键 | 备注 | -| -------------------- | -------------------------- | ---------------------------------------------------------- | -| 在顶层引用前插入空块 | Ctrl Alt Enter / ⌘ ⌥ Enter | wysiwyg 模式 | -| 在顶层引用后插入空块 | Alt Enter / ⌥ Enter | wysiwyg 模式 | -| 插入块元素 | Ctrl Shift : / ⌘ ⇧ : > | Ctrl Shift : / ⌘ ⇧ :: 块元素变为引用 >: 内联元素中插入引用 | -| 引用和块元素之间切换 | Ctrl ; / ⌘ ; | | - -### 代码块 Ctrl U / ⌘ U - -| 名称 | 快捷键 | -| ---------------------- | ------------------- | -| 输入框和代码块之间切换 | Alt Enter / ⌥ Enter | -| 隐藏编辑界面 | Escape | -| 选中所有代码 | Ctrl A / ⌘ A | - -### 表格 Ctrl M / ⌘ M - -| 名称 | 快捷键 | -| ---------------------- | --------------------------- | -| 在上方插入一行 | Ctrl + / ⌘ ⇧ F | -| 在下方插入一行 | Ctrl + / ⌘ + | -| 删除行 | Ctrl - / ⌘ - | -| 在左边插入一列 | Ctrl Shift + / ⌘ ⇧ G | -| 在右边插入一列 | Ctrl Shift + / ⌘ ⇧ + | -| 删除列 | Ctrl Shift - / ⌘ ⇧ - | -| 左对齐 | Ctrl Shift L / ⌘ ⇧ L | -| 中对齐 | Ctrl Shift C / ⌘ ⇧ C | -| 右对齐 | Ctrl Shift R / ⌘ ⇧ R | -| 光标移动到输入框中 | Alt Enter / ⌥ Enter | -| 输入框之间切换 | Tab | -| 将光标移动到上一个元素 | Shift Tab / ⇧ Tab Backspace | -| 将光标移动到下一个元素 | Tab | - -
- -### 许可证 - -Copyright © 2021 [tanknee ](https://github.com/TankNee).
-This project is [MIT](https://github.com/TankNee/Neeto-Vue/blob/master/LICENSE) licensed. - -[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2FTankNee%2FNeeto-Vue.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2FTankNee%2FNeeto-Vue?ref=badge_large) diff --git a/README.md b/README.md index 508d4f8..0b85c95 100644 --- a/README.md +++ b/README.md @@ -1,279 +1,121 @@ -
-

Neeto Vue

+# 2.1.3 README.md - logo +Template - Icon - App - P3 (3).png -

An Awesome Wiz Note Client

+# Memocast -

English | 简体中文

+![GitHub Workflow Status (branch)](https://img.shields.io/github/workflow/status/TankNee/Neeto-Vue/Neeto-Vue%20Release%20Action/master?label=REALSE%20ACTION\&style=for-the-badge) ![GitHub Releases](https://img.shields.io/github/downloads/TankNee/Neeto-Vue/latest/total?style=for-the-badge) ![GitHub All Releases](https://img.shields.io/github/downloads/TankNee/Neeto-Vue/total?style=for-the-badge) ![GitHub Release Date](https://img.shields.io/github/release-date/TankNee/Neeto-Vue?style=for-the-badge) ![GitHub repo size](https://img.shields.io/github/repo-size/TankNee/Neeto-Vue?style=for-the-badge) ![GitHub](https://img.shields.io/github/license/TankNee/Neeto-Vue?style=for-the-badge) - ![GitHub Workflow Status (branch)](https://img.shields.io/github/workflow/status/TankNee/Neeto-Vue/Neeto-Vue%20Release%20Action/master?label=REALSE%20ACTION&style=for-the-badge) ![GitHub Releases](https://img.shields.io/github/downloads/TankNee/Neeto-Vue/latest/total?style=for-the-badge) ![GitHub All Releases](https://img.shields.io/github/downloads/TankNee/Neeto-Vue/total?style=for-the-badge) ![GitHub Release Date](https://img.shields.io/github/release-date/TankNee/Neeto-Vue?style=for-the-badge) ![GitHub repo size](https://img.shields.io/github/repo-size/TankNee/Neeto-Vue?style=for-the-badge) ![GitHub](https://img.shields.io/github/license/TankNee/Neeto-Vue?style=for-the-badge) +*** -
+## Introduction -### Introduction +一款基于 Electron 、Muya 、Monaco 和为知笔记的编辑器，实现了类似 Typora 的编辑体验，并添加了更优秀的源代码模式，更好的图片服务，支持为知笔记私有部署，提供了众多快捷键。 -[In order to write notes, I develop a note application](https://www.tanknee.cn/2020/10/02/%E6%88%91%E4%B8%BA%E4%BA%86%E8%AE%B0%E7%AC%94%E8%AE%B0%E6%89%8B%E5%86%99%E4%BA%86%E4%B8%80%E4%B8%AA%E5%AE%A2%E6%88%B7%E7%AB%AF/) +## Download -### Wiz Community +你可以在 GitHub 的 Release 页面下载最新版本，与此同时，你也可以使用内置的更新按钮获取最新版本，注意 mac 并不支持直接使用内置更新，因为受限于 macOS 的安全策略，所有自动安装的应用应该被有效地签名。 -Follow Wiz Community in WeChat： +GitHub Release：[Releases · TankNee/Memocast · GitHub](https://github.com/TankNee/Memocast/releases) -![qrcode_for_gh_wizcommunity](./screenshot/qrcode_for_gh_wizcommunity.png) +## Feature -If you intend to prompt the development of Wiz Community，join us pls！ +1. 较为完整的为知服务的支持。 -### ScreenShot + 1. 笔记增删查改 -![image-20200925170200202](./screenshot/image-20200925170200202.png) + 2. 文件夹增删 -![image-20200925170301170](./screenshot/image-20200925170301170.png) + 3. 笔记导出成 PNG、Markdown -![image-20200925170327136](./screenshot/image-20200925170327136.png) + 4. 笔记文件夹批量导出 Markdown -### Installation + 5. 支持为知图片服务 -[Releases](https://github.com/TankNee/Neeto-Vue/releases/latest) + 6. 笔记标签增删查改 -You are also be able to check update in Neeto-Vue Settings Dialog + 7. 私有化部署服务器的支持 -![image-20201011103144579](./screenshot/image-20201011103144579.png) +2. 良好的 Markdown 编辑器体验 -#### Arch Linux + 1. 按下 @ 快捷输入 -Install and upgrade from [AUR](https://aur.archlinux.org/packages/neeto-vue-bin/) + 2. 完整的快捷键支持，并在 macOS 下支持菜单和帮助查询。 -Thanks to [yjun123](https://github.com/yjun123)'s contribution. + 3. 将为知的网页剪辑笔记轻松转换为可阅读的 Markdown 文件 -```bash -# AUR helper -# yay -yay -S neeto-vue-bin + 4. 良好的图片支持，支持为知图片，支持 PicGo 上传图片，支持本地图片 -# pikaur -pikaur -S neeto-vue-bin -``` + 5. 相比 marktext ，编辑器做了很多的优化和本地化 -### Feature + 6. 支持笔记目录，支持目录跳转 -- More Beautiful + 7. 支持流程图，vega 图，mermaid 图等等 -- More Powerful + 8. 笔记锁定模式，锁定之后键盘无法输入，减少误触 -- Lighter Size + 9. 所见即所得，良好输入体验 -- Better Dark Mode In Desktop Platform + 10. 支持 PicGo 图片服务，将笔记图片上传到指定图床 -- Export single note or whole note folder to certain path + 11. 支持使用 pangu 格式化 markdown 文本，自动在中英文字符之间加入空格 -- Loading Animation + ```text + 你好Memocast => 你好 Memocast + ``` -- New version check +3. 强大的源代码模式 -- International, support English and Chinese(Simplified) + 1. 使用 Monaco 作为源代码编辑器 -- Keymap: [vditor keymap](#Change Log and Keymap) + 2. 使用 `CmdOrCtrl + Shift + .` 快捷切换源代码模式和 markdown 模式 -- Support to send note to flomo app + 3. 语法高亮 -- Support note lock + 4. 侧边栏预览 -### Attention +4. 完整开源， 项目 All in Github， 在网络畅通的情况下可以使用内置的自动更新，快速将软件更新到最新版。 -- There's another problem with copying notes, Since I haven't handled the transfer of note resources, I don't recommend copying notes for the time being -- Image upload service only supports drag and drop upload or fill in picture link directly -- When using the wiz official image service, only the temporary address of the image will be displayed -- For the time being, only the third-party Web upload service is available. (Settings > > editor > > image upload service) please refer to：[picgo-plugin-web-uploader](https://github.com/yuki-xin/picgo-plugin-web-uploader) - - `url`: Picture upload api url - - `paramName`: POST parameter name(eg:`image`) - - `jsonPath`: Jsonpath of the return value of the image URL`(eg:data.url)` - - `customHeader`: custom request http headers,using standard JSON schema(eg: `{"key":"value"}`) - - `customBody`: custom request body, using standard JSON schema(eg: `{"key":"value"}`) +*** -### Change Log and Keymap +## Screenshot -
-Version change log +### 主界面 -## 2021 06 22 Update 1.0.3 +![](https://img.tanknee.cn/blogpicbed/2021/07/08/202107083870b7fefdc91.png) -1. fix #72，#73 -2. fix some issues of dependencies +### 编辑器 -## 2021 01 17 Update 1.0.2 +![](https://img.tanknee.cn/blogpicbed/2021/07/08/2021070803b63e24f9b6d.png) -1. Remove the underline of links -2. Extract source plain text from note content instead of using the origin markdown text +### 快捷输入 -## 2020 12 22 Update 1.0.0 +![](https://img.tanknee.cn/blogpicbed/2021/07/08/20210708a8305ac3abc86.png) -1. Realize the label system -2. Right click to upload pictures, which depends on picgo -3. Optimize a lot of details +### 源代码模式 -## 2020 12 22 Update 0.0.23 +![](https://img.tanknee.cn/blogpicbed/2021/07/08/20210708b84241135796a.png) -1. To achieve a simpler image upload method: right click in the editor and select the image to upload. -2. Temporarily abandon the drag upload mode. +更多特色功能还请下载之后体验 -## 2020 12 19 Update 0.0.22 +*** -1. Add Chinese readme file -2. Improve the readme description -3. Add note locking function to make it easier to check notes. +## Reference -## 2020 12 17 Update 0.0.21 +感谢 Quasar Framework、Monaco 以及 MarkText 项目，从他们身上学到了很多，Memocast 有很多的灵感都来自他们，笔记的所见即所得编辑器来自 MarkText 中的 Muya 编辑器，源代码模式使用的编辑器来自 Monaca-Editor 项目。 -1. Add flomo API support. Set > > Service > > flomo. Then use the right-click menu in the list to send notes to flomo -2. Upgrade note editor to v3.7.1 -3. Cache key naming policy adjustment +--- -## 2020 12 03 Update 0.0.20 +## Sponsor -1. Fixed the problem that the server could not display the folder when it returned the out of order folder list +| | +|:----------------------------------------------------------------------------------------------------------------:| +| https://github.com/lifeend | -## 2020 11 30 Update 0.0.19 +--- -1. Repair the export failure when there are illegal characters in the note name +## Contributor -## 2020 11 27 Update 0.0.18 +感谢所有Memocast和Neeto-Vue的贡献者！ -1. Export a single file to markdown -2. Export the entire folder to the specified directory in the format of markdown - -## 2020 09 27 Update 0.0.6 - -1. Better login experience -2. Optimize the interface without content -3. Optimize code logic - -## 2020 09 26 Update 0.0.5 - -1. Add GitHub to build automatically - -## 2020 09 25 Update 0.0.4 - -1. Optimize the header display in MacOS -2. Add vditor shortcut key, [shortcut key to check address]（ https://ld246.com/guide/markdown ) -3. Optimization Icon -4. Add the Save button in the lower right corner of vdtor, but the outline button in the upper right corner has not been implemented -5. Learn from wizlite to open the links in notes -6. Optimize invalid code - -## 2020 09 22 Update 0.0.3 - -1. Version updated to 0.0.3 -2. Add drag and drop image upload -3. Drag the picture directly into the editor -4. Remember to click the location of the image to be inserted first, otherwise it will be inserted directly into the place where I last clicked. I have no way to fix it for the time being -5. Fix the size of editor area -6. Add notes to modify the date display -7. Fix the problem of missing translation - -
- -
-Keymap reference - - -[Origin Site](https://ld246.com/article/1582778815353#English) - -## English - -### Summary - -| Name | Keymap | Remarks | -| ---------------------- | --------------------- | ----------------- | -| Emoji | :/⌘ E | | -| Headings | Ctrl H / ⌘ H | see below | -| Bold | Ctrl B / ⌘ B | | -| Italic | Ctrl I / ⌘ I | | -| Strikeout | Ctrl S / ⌘ S | | -| Link | Ctrl K / ⌘ K | see below | -| Unordered List | Ctrl L / ⌘ L | see below | -| Ordered List | Ctrl O / ⌘ O | see below | -| Task List | Ctrl J / ⌘ J | see below | -| Blockquote | Ctrl ; / ⌘ ; | see below | -| Horizontal | Ctrl Shift H / ⌘ ⇧ H | | -| Code Block | Ctrl U / ⌘ U | see below | -| Inline Code | Ctrl G / ⌘ G | | -| Insert Block to Before | Ctrl Shift B / ⌘ ⇧ B | wysiwyg & ir mode | -| Insert Block to End | Ctrl Shift E / ⌘ ⇧ E | wysiwyg & ir mode | -| Table | Ctrl M / ⌘ M | see below | -| Undo | Ctrl Z / ⌘ Z | | -| Redo | Ctrl Y / ⌘ Y | | -| Hide Edit | Ctrl P / ⌘ P | sv mode | -| Fullscreen | Ctrl ' / ⌘ ' | | -| Move Block to Up | Ctrl Shift U / ⌘ ⇧ U | wysiwyg & ir mode | -| Move Block to Down | Ctrl Shift D / ⌘ ⇧ D | wysiwyg & ir mode | -| Remove | Ctrl Shift X / ⌘ ⇧ X | wysiwyg mode | -| At User | @ | | -| Mistyped | Backspace | | - -### Headings Ctrl H / ⌘ H - -| Name | Keymap | -| ------- | -------------------------------------- | -| Bigger | Ctrl + / ⌘ + | -| Smaller | Ctrl - / ⌘ - | -| H1-H6 | Ctrl Alt 1/2/3/4/5/6 / ⌘ ⌥ 1/2/3/4/5/6 | -| Menu | Ctrl H / ⌘ H | - -### Link Ctrl K / ⌘ K - -| Name | Keymap | -| --------------------- | ------------------- | -| Toggle Input and Link | Alt Enter / ⌥ Enter | -| Toggle Input | Tab | - -### List Ctrl L/O/J / ⌘ L/O/J - -| Name | Keymap | Remarks | -| ------------ | -------------------------------------------- | ----------------------------------------------------- | -| Indent | Tab Ctrl Shift I / ⌘ ⇧ I | Tab: Caret must be at Zero | -| Unindent | Shift Tab / ⇧ Tab Ctrl Shift O / ⌘ ⇧ O Enter | Shift Tab / ⇧ Tab: Caret must be at Zero Enter: Empty | -| Toggle Check | Ctrl Shift J / ⌘ ⇧ J | Task List | - -### Blockquote Ctrl ; / ⌘ ; - -| Name | Keymap | Remarks | -| ----------------------- | -------------------------- | ----------------------------------------------------- | -| Move Caret to Top Start | Ctrl Alt Enter / ⌘ ⌥ Enter | wysiwyg mode | -| Move Caret to Top End | Alt Enter / ⌥ Enter | wysiwyg mode | -| Insert Blockquote | Ctrl Shift : / ⌘ ⇧ : > | Ctrl Shift : / ⌘ ⇧ :: Block Element >: Inline Element | -| Toggle Blockquote | Ctrl ; / ⌘ ; | | - -### Code Block Ctrl U / ⌘ U - -| Name | Keymap | -| --------------------------- | ------------------- | -| Toggle Input and Code Block | Alt Enter / ⌥ Enter | -| Hide Edit | Escape | -| Select all Code Block | Ctrl A / ⌘ A | - -### Table Ctrl M / ⌘ M - -| Name | Keymap | -| --------------------------- | --------------------------- | -| Insert 1 above | Ctrl + / ⌘ ⇧ F | -| Insert 1 below | Ctrl + / ⌘ + | -| Delete Row | Ctrl - / ⌘ - | -| Insert 1 left | Ctrl Shift + / ⌘ ⇧ G | -| Insert 1 right | Ctrl Shift + / ⌘ ⇧ + | -| Delete Column | Ctrl Shift - / ⌘ ⇧ - | -| Left Alignment | Ctrl Shift L / ⌘ ⇧ L | -| Center Alignment | Ctrl Shift C / ⌘ ⇧ C | -| Right Alignment | Ctrl Shift R / ⌘ ⇧ R | -| Move Caret to Input | Alt Enter / ⌥ Enter | -| Toggle Input | Tab | -| Move Caret to Previous Cell | Shift Tab / ⇧ Tab Backspace | -| Move Caret to Next Cell | Tab | - -
- -### License - -Copyright © 2021 [tanknee ](https://github.com/TankNee).
-This project is [MIT](https://github.com/TankNee/Neeto-Vue/blob/master/LICENSE) licensed. - -[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2FTankNee%2FNeeto-Vue.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2FTankNee%2FNeeto-Vue?ref=badge_large) +Thanks to all Memocast's contributors as well as Neeto-Vue's contributors!