purocean / yn Goto Github PK

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.

Home Page: https://yank-note.com

License: GNU Affero General Public License v3.0

JavaScript 7.44% HTML 0.39% Vue 27.64% TypeScript 62.80% CSS 1.20% Shell 0.06% SCSS 0.46% Lua 0.01%

vue markdown monaco-editor notebook koa2 vscode electron markdown-it markdown-editor editor

yn's Introduction

Yank Note

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

Not recommended

English | 中文说明

[toc]{level: [2]}

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 embedded Echarts graphics
Embed Mermaid graphics: document supports embedded Mermaid graphics
Embed Luckysheet tables: document supports embedded 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

Changelogs

v3.68.0 2024-04-23

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

feat: Added the feature to focus on the currently open document in the sidebar
feat: Optimized the background color for dark theme image previews
fix: Fixed the issue where the Luckysheet editing dialog could not be operated
fix: Fixed the issue where the document may not be closed after enabling auto-save
chore: Upgraded markdown-it to 14.1.0
chore: Upgraded Monaco editor to 0.47.0
chore: Upgraded viewerjs to 1.11.6
chore: Upgraded katex to 0.16.10

More release notes

Supports

Wechat Group

yn's People

Contributors

Stargazers

Watchers

Forkers

lisazz gitredwall dark-wind jasonhu alexshilucky vforks lin0244 phamay torns budding888 stlcours fucora soiieking yunjianleo codesopen auro-star stlee42 wuyiliang0 dgtgtjs2 yurstang pggpjj cyzeng-luca unitysir dingshibo as010101 frankloud seanry erickwang 97zhaodashuai limolly yixf-self protonuniverse xiuda3411 sth4me andrew-asa haoge999 nathanwang11 lifetruth-liu yongzeyang ccmuyu neverland3124 siyuchen1 fc-wd ssryds freeflash saifreedom diweiqiang cellocello iblctw vhibli weixikai share020 yilangxu awesome-jianso zhuchuan1978 brody911 leemoispace wwwyyyccc123 dongyaosheng jaysonli gyuoin noisnemid cdeeef anguslilei joooooooooojo vixeruntr fan93meng milk-xxy assionted singacycle clickto forvd xiaodaner necokeine nmaexc qhx0807 warlingzhang miao413 wayswang archerprince liamstark yangfengkaust lansexiatian shumaoz dongxr lingluanchen shallslls macshion xiugang emtiantian linannk wingman639 zxc1212sc1000 flyinghare dalianglee venlafaxine wpu93 wang-a11 wwm-yingz sustcsugar

yn's Issues

是否可以在linux上只跑服务端，通过浏览器访问像code-server一样

现在的linux版本在没有桌面环境的情况下无法运行，如果能在无桌面环境的linux系统上运行，通过浏览器访问就太好了。

【建议】增加仓库级别的加密

目前只有 .c.md 结尾的单文件支持加解密操作
建议：增加仓库级别的加解密操作。原因如下：
- 某个仓库可能包含着大量的加密文件，比如该仓库可能专门记录账号密码相关信息；
- 只支持单文件加密是细粒度的操作，增加仓库级别的加密可以看做粗粒度的操作，粗细粒度均支持，可更灵活地满足使用者的不同场景需求：比如，我把 A 仓库设置为加密仓库，切换到该仓库时，需要输入一次密码，进入该仓库后，可方便地浏览（读写）所有文件内容（否则，单文件加密的话，只能看一个文件输入一次密码，很繁琐，体验不好），在此基础上，也同样可以支持 .c.md 的单文件加密（相当于该文件属于更高一级的隐私）。

总结：支持仓库级别的加密，仓库级别的加密和单文件加密结合，可灵活满足更多的场景需求，使用体验也更好。仅供提议，共同探讨。感谢分享。

能否做一个嵌入vscode的extension呢

可不可以增加阅读模式

把编辑界面隐藏掉，只看预览

app store下载安装后启动闪退

macOS Version: macOS 10.13.6 High Sierra (17G14042)
yn version: 3.16.1

不知道在哪里看日志，如果需要日志的话，告诉我在哪里看，我再补充信息

请问如何在Windows下安装与使用呢？

如何改造成web版本

你好，我想改造成web版，在线编辑查看文档，比较方便，最好有docker镜像版一键部署。不过试了试，本地构建有错误（好像跟electron相关）。希望大佬有个源码构建或者构造web版的详细文档。

您好，感觉您这个很有趣，在使用中想咨询一些问题，能方便留个联系方式吗

请问有在全仓库中查找字符串的功能吗？

如题

在ubuntu下无法正常显示图标

可以检索到在 /usr/share/icons/hicolor/0x0/apps 这个路径下有正确的，且没有损坏的图标的 png文件



并且我很奇怪为什么这个图标被放在了0x0 这个文件夹下，而不是512x512 这个文件夹下，而且也只有yank-note这一个程序使用了0x0这个文件夹

Yank Note 使用分享

这里我将分享 Yank Note 的方方面面，也欢迎大家分享

【建议】希望支持编辑和预览调换位置

源码构建、打包步骤

建议，readme中增加源码构建、打包步骤，本地执行 ./scripts/install.sh 或 yarn、npm install，总是卡在这报各种错误：

yarn install v1.22.17
[1/4] Resolving packages...
[2/4] Fetching packages...
[3/4] Linking dependencies...
warning " > @vue/[email protected]" has incorrect peer dependency "[email protected]".
warning "@vue/eslint-config-standard > [email protected]" has unmet peer dependency "webpack@>=1.11.0".
warning " > @vue/[email protected]" has incorrect peer dependency "@typescript-eslint/eslint-plugin@^2.7.0".
warning " > @vue/[email protected]" has incorrect peer dependency "@typescript-eslint/parser@^2.7.0".
warning " > [email protected]" has unmet peer dependency "postcss@^8.1.0".
[4/4] Building fresh packages...
[1/5] ⠁ node-pty
[-/5] ⠁ waiting...
[5/5] ⠁ electron
[4/5] ⠁ esbuild

请问没有代码提示吗？

转为PDF之后，文字无法选中

转为PDF之后，像是图片格式的，文字无法选中。
代码区的背景也没有了，不知道这个算不算问题。

Plantuml预览加载不出来

三五行的还可以，行数多了，右侧预览就出不来图形，一直在转圈。但是点击放大器，在新窗口是可以加载出图形的。

用安装包自带的plantuml.jar独立运行啥的也都很正常

导出PDF能带目录么

这个导出我看不带目录,是否是需要设置

[BUG]: macOS 运行 Python 代码产生 spawn EPERM 错误

Mac APP Store 下载的软件
macOS 10.15.7, Full disk permission in the Security setting
默认 Python 版本
Python 3.8.8 (default, Apr 13 2021, 12:59:45)
[Clang 10.0.0 ] :: Anaconda, Inc. on darwin

can not open yank note

in macbookpro, use yank note for a period of time， buf suddenly appear the following error，and can not open yank md file

建议：按Tab增加层级

当我使用todo或者思维导图的时候，我想让当前行整体前进一个 Tab，我需要把光标调到 - 前面。这样比较麻烦，是否考虑增加在 - 后面直接按下 Tab ，可以增加层级。

Originally posted by @lizhendong128 in https://github.com/purocean/yn/discussions/72

如果能作为vscode插件，依托git仓库作存储及同步，那就完美了。

luckysheet如何使用呢

请问下这个luckysheet 的表格文件如何生成呢？ @purocean

上传图床功能

能否添加在图片粘贴到编辑区时利用PicGo等图像上传器自动上传到外部图床的功能？类似Typora中图片的单个和一键上传功能

mac下能否支持全屏显示

能否支持一下

Katex公式中如果出现中文无法解析，但是在typora中可以正常解析

我想把之前typora下写的一些文档导入进来，然后发现含有中文的公式无法解析

所见即所得

我最近在打算给我的 https://github.com/tiddly-gittly/TidGi-Desktop 做所见即所得，调研了一下 Monaco 没法做 WYSIWYG ，你这方面是怎么打算的呢？

在线体验版，在新建一个md文件之后会自动填充FEATURES.md的内容；以及渲染混乱的问题

在线体验版，在新建一个md文件之后会自动填充FEATURES.md的内容

并且在全选之后，如果直接粘贴大段文本来覆盖掉自动填充进去的内容，右侧的渲染结果会出现混乱
（经测试，全选删除后，再进行粘贴不会出现混乱）

并且在全选删除之后，右侧的渲染结果不会消失

然后我测试了ubuntu上的版本
在yank note 内新建md文件并没有自动填充FEATURES.md的内容
然后，我手动将FEATURES.md的内容粘贴进新建的md文件，渲染正常

之后，与在在线体验版中的操作相同，将同样的大段文本直接粘贴进去
右侧渲染结果混乱，仍然出现了FEATURES.md的内容

全部删除后，右侧渲染结果没有变化

撤销删除操作，关闭软件后台再重新启动，之前新建的文件渲染正常

同时，重启之后，打卡的第一个文件一定渲染正常，但是点开另一个文档之后，比如 readme.md，再切换回第一个文档就回出现渲染混乱的情况

Bug: Incorrect checkbox toggling within a table

如视频所示，如果两个checkbox并列一个row的话，当第二个column的checkbox toggle的时候，第一个反而会被toggle。

20220216-181610.mp4

可以修复一下这个bug吗？另外我想请教一下如何通过改变dom里checkbox的state从而改变markdown本身，除了需要知道这个dom元素是由哪一个line render得来的之外还需要什么呢？

dark主题是否考虑从高级功能里提出来

这个基本是刚需了，放在高级了真心有不想用的感觉，可以再想写高级特性来做收费大佬你说呢

linux端使用求助

下载安装了Yank-Note-linux-amd64-3.16.1.deb包，运行yank-note，报错信息如下：

innerError Error: Cannot find module '../build/Debug/pty.node'
Require stack:
- /opt/Yank Note/resources/app.asar/node_modules/node-pty/lib/unixTerminal.js
- /opt/Yank Note/resources/app.asar/node_modules/node-pty/lib/index.js
- /opt/Yank Note/resources/app.asar/dist/main/server/index.js
- /opt/Yank Note/resources/app.asar/dist/main/app.js
- 
    at Module._resolveFilename (internal/modules/cjs/loader.js:972:15)
    at Function.n._resolveFilename (electron/js2c/browser_init.js:249:921)
    at Module._load (internal/modules/cjs/loader.js:848:27)
    at Function.f._load (electron/js2c/asar_bundle.js:5:12633)
    at Module.require (internal/modules/cjs/loader.js:1032:19)
    at require (internal/modules/cjs/helpers.js:72:18)
    at Object.<anonymous> (/opt/Yank Note/resources/app.asar/node_modules/node-pty/lib/unixTerminal.js:30:15)
    at Module._compile (internal/modules/cjs/loader.js:1152:30)
    at Object.Module._extensions..js (internal/modules/cjs/loader.js:1173:10)
    at Module.load (internal/modules/cjs/loader.js:992:32) {
  code: 'MODULE_NOT_FOUND',
  requireStack: [
    '/opt/Yank Note/resources/app.asar/node_modules/node-pty/lib/unixTerminal.js',
    '/opt/Yank Note/resources/app.asar/node_modules/node-pty/lib/index.js',
    '/opt/Yank Note/resources/app.asar/dist/main/server/index.js',
    '/opt/Yank Note/resources/app.asar/dist/main/app.js',
    undefined
  ]
}

似乎是缺少了某些js文件，请问应该怎么操作，对npm不熟，不太懂怎么解决

能不能自定义快捷键呢

lin下有些快捷键和系统冲突了，例如多行编辑使用alt
vscode的setting里面提供了alt+super的备选项，这个就遭咯

TOC可以自定义序号吗？

[toc]{type: "ol", level: [1,2,3]}
默认序列是

1.
    i.
        a.
        b.
    ii.
2.
3.

能修改成：

1
1.1
1.1.1
2.
2.1
2.1.1
2.2

这种吗？

想用来写手册，一般手册都是1.1.1这种序列的。