Thanks to visit codestin.com
Credit goes to github.com

Skip to content
/ yn Public
forked from purocean/yn

自用 markdown 编辑器,用来记工作日志之类

Notifications You must be signed in to change notification settings

GitRedWall/yn

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

99 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

自用 markdown 编辑器

vue + monaco-editor + markdown-it + nodejs + Koa

目标

  1. 界面字大不费眼 :)
  2. markdown 撰写
  3. 图片文件保存在本地,导出 markdown 文件可简单处理离线工作
  4. 支持一些流程图表绘制 startuml mermaidt
  5. 支持加密解密,用来保存账号等隐私文件,文件可单独设置密码
  6. 不需要更多花哨功能,简单够用就行
  7. 尽量少依赖三方库,也不花心思维护,杂凑在一起的功能,恰好工作即可 ^_^
  8. 在文档中运行 PHP Python Node.js bash 代码块

上手使用

  • cd frontend && yarn && yarn run dist && cd ../backend && yarn && node main.js
  • 访问 http://localhost:3000
  • 新增文件:双击目录
  • 删除文件/目录:shift + 右键文件/目录
  • 重命名文件/目录:ctrl + 右键文件/目录
  • 默认快捷键参考 vscode
  • 自定义编辑器快捷键
    • Ctrl + s 保存文档
    • Ctrl + Shift + Up 当前行上移
    • Ctrl + Shift + Down 当前行下移
    • Ctrl + Shift + D 重复当前行
    • Ctrl + Alt + D 插入当前日期
    • Ctrl + Alt + T 插入当前时间
    • Ctrl + Alt + F 插入文件附件

功能

  • 同步预览滚动,实现得较粗糙
  • 目录大纲展示
  • 文件加密:以 .c.md 结尾的文件视为加密文件
  • 自动保存(加密文档不自动保存)
  • 列表自动补全
  • 粘贴剪切板里面的图片
  • 添加附件到文档
  • 运行 PHP,nodejs,Python,bash 代码,代码块第一行需要包含以 --run-- 字符串,示例见下面截图,当然需要安装相关环境
  • 开启了 HTML 解析,可以直接在文档里面使用 HTML 代码
  • docx 格式导出,需要安装 pandoc
  • markdown 编辑器 monaco-editor
  • markdown 解析 markdown-it
  • GitHub 风格样式和特性 GitHub Flavored Markdown Spec
  • 待办列表 GitHub-style task lists
  • mermaid 图形 mermaid
  • Plantuml 图形,需要安装 Java,graphviz markdown-it-plantuml
  • katex 公式解析 markdown-it-katex
  • 元素属性书写 markdown-it-attrs
  • 表格解析增强,支持表格标题多行文本,列表等特性 markdown-it-multimd-table

开发

  • 后端: cd backend; node main.js
  • 后端: cd frontend; yarn run dev

开发计划

  • 回收站
  • 文件重命名
  • 文件树目录排列
  • 打印 PDF 样式
  • 保存快捷键
  • 加密解密
  • 优化输入列表体验
  • 图片粘贴预览
  • 未保存切换文件自动保存
  • 密码输入优化
  • 静态文件
  • 公式显示
  • 运行 python php nodejs 块
  • 大纲展示
  • 同步滚动
  • 暗色主题
  • 运行代码支持图表生成
  • 认证,// 如有需要使用 nginx
  • 全文查找 Ctrl + p
  • git 备份,// 使用 OneDrive 同步备份
  • 标签
  • 移动端展示

截图 截图 截图

About

自用 markdown 编辑器,用来记工作日志之类

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 62.5%
  • Vue 37.1%
  • HTML 0.4%