- **Easy to use**：Use Monaco kernel, optimize for Markdown specially, and have the same editing experience as VSCode.
- **Powerful function**：Gadgets, runnable code blocks, tables, Plantuml graphics, Drawio graphics, macro replacements, etc., can be embedded in the document.
- **Strong compatibility**：Data is saved as local Markdown files, and the extension functions are implemented in the original syntax of Markdown as far as possible.
- **Easy to use**：Use *Monaco* kernel, optimize for Markdown editing, and have the same editing experience as VSCode.
- **Powerful**：Widgets, runnable code blocks, tables, Plantuml, Drawio, macro replacements, etc., can be embedded in the document.
- **High compatibility**：Data is saved as local Markdown files, and the extension functions are implemented in the original syntax of Markdown as far as possible.
- **Plug-in extension**：Support users to write their own plug-ins to expand the functionality of the editor.
- **Encryption supported**：Use encryption to save private files such as account number, and the password can be set separately for each file.
## Notes
## Attention
- Yank Note is a Markdown editor **for programmers**. The target application scenario is to write articles and take notes on the local machine.
- For greater expansibility and convenience, Yank Note sacrifices security protection (command execution, arbitrary file reading and writing). If you want to use it to open a foreign Markdown file, **be sure to carefully identify whether the content of the file is trustworthy**.
- Yank Note is a Markdown editor **for programmers**, purpose to write articles and take notes on the local machine.
- For mort extendable, Yank Note sacrifices security protection (command execution, arbitrary file reading and writing). If you want to use it to open a foreign Markdown file, **be sure to carefully identify whether the content of the file is trustworthy**.
- The encryption and decryption of encrypted files are both completed at the front end. Please **be sure to remember your password**. Once the password is lost, it can only be cracked violently.
## Yank-Note V3 Development Plan
## Yank-Note V3 Plan
The core goal of V3 is to refactor the code to improve application robustness, expansibility, and Markdown rendering performance.
@@ -32,7 +34,7 @@ The core goal of V3 is to refactor the code to improve application robustness, e
- [x] Optimize the performance of Markdown rendering, and support the extension of Vue component mode
- [x] Refactor Electron code
- [x] Refactor business logic, and decouple components
- [x] Improve the documentation of custom plug-in
- [x] Improve the documentation of custom plug-in
- [ ] Enhance document retrieval and citation experience
- [ ] Refactor the shortcut key processing layer, and support custom shortcut keys
- [ ] Other unfinished functions of V2
@@ -42,51 +44,49 @@ The core goal of V3 is to refactor the code to improve application robustness, e
For more information on how to use the following functions, please see [characteristic functions description](./help/FEATURES.md)
- Synchronous scrolling: the editing area and the preview area scroll synchronously, and the preview area can be scrolled independently
-Directory outline: quickly jump to the corresponding location of the document through the directory outline in the preview area
-File encryption: files ending with `.c.md` are treated as encrypted files
- Auto-save: automatically save files after editing, with orange title bar reminder for unsaved files (encrypted documents are not automatically saved)
- Edit optimization: automatic completion of list
- Paste pictures: you can quickly paste pictures from the clipboard and insert them as files or Base64
- Embed attachments: you can add attachments to the document and click to open them in the operating system.
- Code running: support to run JavaScript, PHP, nodejs, Python, bash code
- To-do list: support to display the to-do progress in the document. Click to quickly switch the to-do status.
- Quickly Open: you can use shortcut key to open the file switch panel to quickly open files, tagged files, and full-text search for file contents.
-Built-in terminal: support to open the terminal in the editor to quickly switch the current working directory
-Formula resolving: support to input katex formula code
- Style: Markdown uses GitHub styles and features
-Data repository: multiple data locations can be defined for document classification
- External link conversion: convert external link or Base64 pictures into local pictures
-**Sync scrolling:** the editing area and the preview area scroll synchronously, and the preview area can be scrolled independently
-**Outline:** quickly jump to the corresponding location of the document through the directory outline in the preview area
-**Encryption:** files ending with `.c.md` are treated as encrypted files
-**Auto-save:** automatically save files after editing, with orange title bar reminder for unsaved files (encrypted documents are not automatically saved)
-**Editing:** automatic completion of list
-**Paste images:** you can quickly paste pictures from the clipboard and insert them as files or Base64
-**Embed attachments:** you can add attachments to the document and click to open them in the operating system.
-**Code running:** support to run JavaScript, PHP, nodejs, Python, bash code
-**To-do list:** support to display the to-do progress in the document. Click to quickly switch the to-do status.
-**Quickly Open:** you can use shortcut key to open the file switch panel to quickly open files, tagged files, and full-text search for file contents.
-**Integrated terminal:** support to open the terminal in the editor to quickly switch the current working directory
-**Katex:** support katex expression
-**Style:** Markdown uses GitHub styles and features
-**Repository:** multiple data locations can be defined for document classification
-**External link conversion:** convert external link or Base64 pictures into local pictures
- HTML resolving：you can use HTML code directly in the document, or use shortcut keys to copy and paste HTML to Markdown
- Multiple formats export: the backend uses pandoc as converter
- TOC support: write `[toc]{type: "ol", level: [1,2,3]}` to generate TOC where you need to generate a directory
- Edit table cell: double-click a table cell to quickly edit
- Copy title link: copy title link path to the clipboard for easy insertion into other files
- Embedded gadgets: document supports embedded HTML gadgets
- Embed Plantuml graphics: you need to install Java and graphviz
-Nested list to mind map display: nested list can be displayed in the form of a mind map
- Element attribute writing: any attribute of an element can be customized
- Table resolving enhancement: support table title with multiple lines of text, list and other features
- Document cross-link jump: support to link other documents in the document and jump to each other
- Footnote function: support writing footnotes in the document
-Container blocks: support custom containers similar to VuePress default themes
- Macro replacement: support for embedded JavaScript expressions to dynamically replace document content
- Image hosting service: support [PicGo](https://picgo.github.io/PicGo-Doc/) image hosting service
- Custom plug-ins: support writing JavaScript plug-ins to expand editor functionality. The plug-in is placed in the `home directory/plugins`. Refer to [plug-in Development Guide](./help/PLUGIN.md)
-**Multiple formats export:** the backend uses pandoc as converter
-**TOC:** write `[toc]{type:** "ol", level:** [1,2,3]}` to generate TOC where you need to generate a directory
-**Edit table cell:** double-click a table cell to quickly edit
-**Copy title link:** copy title link path to the clipboard for easy insertion into other files
-**Embedded Widgets:** document supports embedded HTML widgets
-**Embed Plantuml graphics:** you need to install Java and graphviz
-**Mind map:** nested list can be displayed in the form of a mind map
-**Element attribute writing:** any attribute of an element can be customized
-**Table enhancement:** support table title with multiple lines of text, list and other features
-**Document link:** support to link other documents in the document and jump to each other
-**Footnote:** support writing footnotes in the document
-**Custom container:** support custom containers similar to VuePress default themes
-**Macro replacement:** support for embedded JavaScript expressions to dynamically replace document content
-**Image hosting service:** support [PicGo](https://picgo.github.io/PicGo-Doc/) image hosting service
-**Custom plug-ins:** support writing JavaScript plug-ins to expand editor functionality. The plug-in is placed in the `home directory/plugins`. Refer to [plug-in Development Guide](./help/PLUGIN.md)
Blocking a user prevents them from interacting with repositories, such as opening or commenting on pull requests or issues. Learn more about blocking a user.
purocean