Yank Note

A hackable markdown note application for programmers Download | Try it Online >>>

English | 中文说明

[toc]{level: [2]}

Highlights

• Easy to use: Use Monaco kernel, optimize for Markdown editing, and have the same editing experience as VSCode.
• Powerful: Applets, 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.

Attention

• For more 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 Plan

The core goal of V3 is to refactor the code to improve application robustness, expansibility, and Markdown rendering performance.

V3 Project Board

• Build with Vite
• Optimize the performance of Markdown rendering, and support the extension of Vue component mode
• Refactor Electron code
• Refactor business logic, and decouple components
• 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
• Add mobile application

Characteristic functions

For more information on how to use the following functions, please see characteristic functions description

• 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: 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 Applets: document supports embedded HTML Applets
• Embed Plantuml graphics: you need to install Java and graphviz
• Embed drawio graphics: document supports embedded drawio graphics
• Embed ECharts graphics: document supports embeded Echarts graphics
• Embed Mermaid graphics: document supports embeded Mermaid graphics
• Embed Luckysheet tables: document supports embeded Luckysheet tables
• 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 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

Screenshots

Changelogs

v3.16.1 2021-12-16

1. feat(table): enhanced table editing, now you can operate table rows and columns by context menu
2. feat(table): support small size table
3. feat(theme): support custom CSS style
4. feat(document): supports linking local files through the file:// protocol
5. feta(sidebar): add create folder button
6. feta(editor): add emoji completion
7. feta(mind map): add priority definition
8. feta(mind map): add fit button
9. fix: fix bugs
10. upd: improve user experience
11. feat(plug-in): add ctx.base.showItemInFolder method
12. feat(plugin): add ctx.base.getRepo method
13. feat(plugin): add ctx.base.getMarkedFiles
14. feat(plugin): add ctx.base.isMarked method
15. feat(plug-in): add ctx.view.getEnableSyncScroll
16. feat(plug-in): add ctx.view.disableSyncScrollAwhile method
17. feat(plug-in): add SETTING_CHANGED hook
18. feat(plugin): add SETTING_PANEL_BEFORE_SHOW hook
19. upd(plugin): remove ctx.tree.refreshRepo method
20. upd(plugin): remove ctx.api.markFile method
21. upd(plugin): remove ctx.api.unmarkFile method
22. upd(plugin): remove ctx.api.fetchMarkedFiles
23. upd(plugin): remove ctx.api.fetchRepositories method
24. upd(plugin): remove ctx.api.openInOS method

More release notes

Supports

Wechat Group