• Stars
    star
    5,609
  • Rank 7,281 (Top 0.2 %)
  • Language
    TypeScript
  • License
    GNU Affero Genera...
  • Created almost 7 years ago
  • Updated about 1 month ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

A highly extensible Markdown editor. Version control, AI Copilot, mind map, documents encryption, code snippet running, integrated terminal, chart embedding, HTML applets, Reveal.js, plug-in, and macro replacement.

Yank Note

A highly extensible Markdown editor, designed for productivity. Download | Try it Online >>>

Download Not recommended

English | 中文说明

[toc]{level: [2]}

Screenshot

Highlights

  • Easy to use: Use Monaco kernel, optimize for Markdown editing, and have the same editing experience as VSCode.
  • Powerful: Support version control; Applets, runnable code blocks, tables, PlantUML, Drawio, macro replacements, etc., can be embedded in the document; support for OpenAI auto completion.
  • 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.

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
  • Version Control: Support backtracking document history versions
  • 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: document supports embedded plantUML graphics
  • 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
  • OpenAI: support for OpenAI auto completion
  • 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

Screenshot Screenshot Screenshot Screenshot Screenshot Screenshot

Changelogs

v3.54.0 2023-06-08

Windows | macOS arm64 | macOS x64 | Linux AppImage | Linux deb

  1. feat: add focus editor shortcut Shift + Alt/Option + X
  2. feat: editor menu supports Chinese
  3. feat: optimize the behavior of clicking preview to scroll to the editor position
  4. feat: optimize the behavior of batch checking to-do items (press Cmd/Ctrl + O after selecting)
  5. feat(plugin): add needReloadWindowWhenChanged field to setting item, support to define whether to reload page after value changes
  6. feat(plugin): SETTING_CHANGED hook adds schema parameter

More release notes

Supports

Wechat Group

More Repositories

1

laravel-template

RESTful 模板,企业号/企业微信微信扫码登录/同步通讯录——Laravel vue2 iView
PHP
124
star
2

tensorflow-simple-captcha

使用 TensorFlow 识别简单图像验证码
Python
46
star
3

yii2-template

Restful 模板,提供企业号微信扫码登录——Yii2 React ant-design
PHP
23
star
4

expose-github-copilot-http-api

将 VSCode 中的 Github Copilot 转化成 HTTP 接口,方便在其他场景使用。
JavaScript
19
star
5

twitter2weibo

推特微博搬运爬虫
TypeScript
18
star
6

yank-note-extension

Yank Note Extensions
TypeScript
16
star
7

Ybox

用 51 单片机做的扫雷游戏机
C
11
star
8

markdown-it-attributes

An alternate of markdown-it-attr, write by TypeScript, 132x faster! Add classes, identifiers and attributes to your markdown with {} curly brackets, similar to pandoc's header attributes.
TypeScript
10
star
9

developer.pebble.com

developer.pebble.com archives
HTML
7
star
10

vue2-admin

RESTful RBAC Auth manager for Vue.js 2
JavaScript
7
star
11

php-db-migration

数据库版本管理迁移工具
PHP
5
star
12

vscode-drawio-preview

TypeScript
5
star
13

yank-note-flutter

Yank Note 移动版本
Dart
5
star
14

USTL-RWSKB

辽宁科技大学人文社科部网上答题,自动答题机
JavaScript
5
star
15

vue2-bootstrap

Bootstrap components built with Vue 2
Vue
3
star
16

kotlin-db-migration

MySQL Migration
Kotlin
2
star
17

php-workflow

A simple exclusive workflow lib
PHP
2
star
18

yank-note-extension-example

TypeScript
2
star
19

cordova-vue-demo

Cordova Vue Vux
Java
2
star
20

remove-sdr-kindle

删除 Kindle 里面多余 sdr 文件夹的脚本
Python
2
star
21

pfuck

Python 撸站框架
Python
2
star
22

yank-note-registry

Yank Note Extension Registry
JavaScript
2
star
23

taro-houseloan

基于 Taro 框架的房贷计算器,小程序 H5
TypeScript
2
star
24

purocean.github.io

https://github.com/purocean/blog
HTML
2
star
25

jmeter-wrapper

JavaScript
1
star
26

php-wechat-sdk

微信SDK
PHP
1
star
27

blog

个人博客
HTML
1
star
28

pebble-watchface

pebble 2 watchface
C
1
star
29

vuepress-plugin-html-applet

Embed HTML Applet iframe to your Vuepress article.
JavaScript
1
star
30

jsonrpc-bridge

TypeScript
1
star