| headingNumber | true | ||||
|---|---|---|---|---|---|
| enableMacro | true | ||||
| customVar | Hello | ||||
| define |
|
English | 中文
[toc]{type: "ol", level: [2]}
<home> 为当前操作系统的用户主目录，例如：
- Windows:
C:\Users\<username> - Linux:
/home/<username> - macOS:
/Users/<username>
应用相关的数据目录存放在 <home>/yank-note 下面，点击托盘菜单“打开主目录”即可查看
目录说明：
-
配置文件
<home>/yank-note/config.json -
导出 docx 参考文档
<home>/yank-note/pandoc-reference.docx -
文档历史版本
<home>/yank-note/histories[!TIP] 如果您不小心丢失了您的文档数据，您可以到此文件夹尝试找回。
[!CAUTION] 出于性能的考虑，超过 102400 个字符的文档将不会储存历史记录。因此请谨慎在文档中嵌入 Base64 图片。
-
插件
<home>/yank-note/plugins -
主题
<home>/yank-note/themes -
扩展
<home>/yank-note/extensions -
其他用户数据
<home>/yank-note/data
需要生成目录的地方写入 [toc]{type: "ul", level: [1,2,3]}
可以控制目录样式 ul 或 ol 和级别
在预览界面打勾试试
-
2021-06-06 10:27TEST1 -
2021-06-06 10:27TEST2 -
2021-06-06 10:27TEST3
- 以
.c.md结尾的文档视为加密文档，可以用来保存机密的信息。 - 加密和解密过程均在前端完成。
- 请务必保管好文档密码，密码一旦丢失就只能自己暴力破解了。
在编辑器中键入 / 可以获得提示
- 高亮：==marked==
- 上标：29^th^
- 下标：H
20 - 脚注：脚注1语法2
- Emoji: :) 😂
- 缩写： *[HTML]: Hyper Text Markup Language *[W3C]: World Wide Web Consortium The HTML specification is maintained by the W3C.
- Wiki 链接：支持使用
[[文件名#锚点|显示文本]]或[[文件名:行,列|显示文本]]语法来链接文档，如 [[README#Highlights|特色功能]] [[README:3,4]] - 标签：#Markdown #使用帮助
此功能使用 markdown-it-github-alerts 实现，支持 Github 风格的警告提示。
[!NOTE] 注意 突出强调用户在浏览时应该注意的信息。
[!TIP] 提示 提供可选的信息以帮助用户更加成功。
[!IMPORTANT] 重要 对于用户成功至关重要的关键信息。
[!WARNING] 警告 由于潜在风险，需要立即引起用户的注意的关键内容。
[!CAUTION] 小心 行动的负面潜在后果。
此功能使用 markdown-it-attributes 实现。
- 红色文字，白色背景，居中和边框{.bgw .text-center .with-border style="color:red"}
- 显示为块元素{.block}
- 转义语法{style="color:red"}
一些内置样式类：
| 类名 | 说明 |
|---|---|
avoid-page-break |
打印/导出PDF时避免页面在此元素中断 |
new-page |
打印/导出PDF时在此元素前分页 |
skip-print |
打印/导出PDF时跳过此元素 |
skip-export |
导出/复制HTML时跳过此元素 |
inline |
当前元素显示为行内元素 |
block |
当前元素显示为块元素 |
reduce-brightness |
使用暗色主题时候降低此元素亮度 |
bgw |
设置当前元素背景为白色 |
copy-inner-text |
标记 “Ctrl/Cmd + 单击左键” 拷贝元素文字 |
wrap-code |
应用于代码块，让其自动换行 |
text-left |
当前元素文字左对齐 |
text-center |
当前元素文字居中对齐 |
text-right |
当前元素文字右对齐 |
with-border |
给当前元素加上边框 |
- 一个段落下如果只有一个图片元素，默认会渲染成块元素并居中。如果要强制显示为行内元素，可以在图片链接参数后面追加
.inline如上图所示。 - 如果要给图片添加白色背景优化展示效果（针对某些透明图片）,可以在图片链接参数后面追加
.bgw如：
- 可以使用markdown-it-imsize的方式来设置图片尺寸 例如这是一个宽度为 16px 的图片: 
只需要在列表根节点加上 {.mindmap} 即可。
- 中心节点{.mindmap}
- [1] 状态可见原则
- [2] 环境贴切原则
- [3] 用户可控原则
- [4] 一致性原则
- [5] 防错原则
- [6] 易取原则
- [7] 灵活高效原则
- [8] 优美且简约原则
- [9] 容错原则
- [10] 人性化帮助原则
脑图使用 kityminder-core 实现。
graph LR
A[Hard] -->|Text| B(Round)
B --> C{Decision}
C -->|One| D[Result 1]
C -->|Two| E[Result 2]
sequenceDiagram
Alice->>John: Hello John, how are you?
loop Healthcheck
John->>John: Fight against hypochondria
end
Note right of John: Rational thoughts!
John-->>Alice: Great!
John->>Bob: How about you?
Bob-->>John: Jolly good!
gantt
section Section
Completed :done, des1, 2014-01-06,2014-01-08
Active :active, des2, 2014-01-07, 3d
Parallel 1 : des3, after des1, 1d
Parallel 2 : des4, after des1, 1d
Parallel 3 : des5, after des3, 1d
Parallel 4 : des6, after des4, 1d
stateDiagram-v2
[*] --> Still
Still --> [*]
Still --> Moving
Moving --> Still
Moving --> Crash
Crash --> [*]
pie
"Dogs" : 386
"Cats" : 85
"Rats" : 15
journey
title My working day
section Go to work
Make tea: 5: Me
Go upstairs: 3: Me
Do work: 1: Me, Cat
section Go home
Go downstairs: 5: Me
Sit down: 3: Me
您可以在 设置 中配置使用本地端点或 PlantUML 在线端点来生成图形。
Important
如果使用本地端点，则系统需要有 Java 环境，并安装有 Graphviz
如果提示 Cannot find Graphviz，请参考 Test your GraphViz installation
示例如下
@startuml a -> b @enduml
此功能使用 markdown-it-multimd-table 实现 支持在表格中使用多行文本和列表。支持表格说明渲染
您可以双击/右键单元格快捷编辑单元格内容，相关快捷键：
DBLClick: 编辑单元格Escape: 退出编辑Enter: 确认编辑并编辑下一行Shift + Enter: 确认编辑并编辑上一行Cmd/Ctrl + Shift + Enter: 确认编辑并插入下一行Tab: 确认编辑并编辑下一列Shift + Tab: 确认编辑并编辑上一列
| First header | Second header |
|---|---|
| List: | More \ |
- over | data \
- several | Test | Test [测试表格]
| First header | Second header |
|---|---|
| AAAAAAAAAAAA | BBBBBBBBBBBBBB |
| AAAAAAAAAAAA | BBBBBBBBBBBBBB |
| AAAAAAAAAAAA | BBBBBBBBBBBBBB |
| AAAAAAAAAAAA | BBBBBBBBBBBBBB |
| AAAAAAAAAAAA | BBBBBBBBBBBBBB |
| Test | Test |
| [小尺寸表格] | |
| {.small} |
| h1 | h2 | h3 |
|---|---|---|
| x1 | x2 | x3 {rowspan=2 style="color:red"} |
| x4 {colspan=2} | ||
| [合并单元格] |
此功能由 KaTeX 提供。
| equation | description |
|---|---|
| divergence of |
|
| curl of |
|
| what? |
支持运行 JavaScript PHP nodejs Python bash bat 代码。
此功能执行外部命令实现，所以需要安装相应环境。
代码块第一行需要包含以 --run-- 字符串，示例如下
Js 代码默认在 Web Worker 中运行，如果需要在主线程中运行，可以在代码块后面加上 --no-worker-- 参数
// --run--
await new Promise(r => setTimeout(r, 500))
console.log('HELLOWORLD')主线程中运行的代码支持使用 ctx 对象访问编辑器 API，示例如下
// --run-- --no-worker--
await new Promise(r => setTimeout(r, 500))
ctx.ui.useToast().show("info", "HELLOWORLD!")
console.log('HELLOWORLD')如果需要输出 HTML，可以在代码块后面加上 --output-html-- 参数
// --run-- --output-html--
console.log(`output <i>HTML</i>`)// --run--
console.log('HELLOWORLD')// --run--
echo 'HELLOWORLD!';# --run--
print('HELLOWORLD')# --run--
dateREM --run--
@echo HELLOWORLD// --run-- gcc $tmpFile.c -o $tmpFile.out && $tmpFile.out
#include <stdio.h>
int main () {
printf("Hello, World!");
return 0;
}// --run-- java $tmpFile.java
class HelloWorld {
public static void main(String[] args) {
System.out.println("Hello, World!");
}
}- 使用
Alt/Option + T或者点击状态栏 切换终端 菜单唤起集成终端 - 支持在编辑器中选中一段代码后按下
Shift + Alt/Option + R直接在终端中运行命令。免去复制粘贴。 - 切换内置终端工作目录到当前目录
右键目录
支持在文档中嵌入 HTML 小工具。
HTML 代码块第一行需要包含以 --applet-- 字符串，其余字符串作为小工具标题，示例如下
<!-- --applet-- Hash -->
<script>
function run (type) {
const input = document.getElementById('input')
const output = document.getElementById('output')
output.value = ''
switch (type) {
case 'md5':
output.value = ctx.lib.cryptojs.MD5(input.value).toString().toLowerCase()
break
case 'sha1':
output.value = ctx.lib.cryptojs.SHA1(input.value).toString().toLowerCase()
break
case 'sha256':
output.value = ctx.lib.cryptojs.SHA256(input.value).toString().toLowerCase()
break
}
output.focus()
output.select()
}
</script>
<div>
输入
<textarea id="input" style="display: block; width: 100%"></textarea>
<button onclick="run('md5')">MD5</button>
<button onclick="run('sha1')">SHA1</button>
<button onclick="run('sha256')">SHA256</button>
<textarea id="output" style="display: block; width: 100%"></textarea>
<button onclick="document.getElementById('input').value = ''; document.getElementById('output').value = ''">清空</button>
<button onclick="var x = document.getElementById('output'); x.value = x.value.toUpperCase()">结果大写</button>
</div>如果没有标题，将没有外部边框装饰
<!-- --applet-- -->
<button onclick="ctx.ui.useToast().show(`info`, `HELLOWORLD!`)">HELLO</button>你也可以 安装并启用 Vue Repl 扩展，使用 Vue SFC 来编写小工具。
Js 代码块第一行包含以 --echarts-- 字符串会被解析成 ECharts 图形，示例如下
// --echarts--
const option = {
// backgroundColor: '#2c343c',
title: {
text: 'Customized Pie',
left: 'center',
top: 20,
textStyle: {
color: '#888'
}
},
tooltip : {
trigger: 'item',
formatter: "{a} <br/>{b} : {c} ({d}%)"
},
visualMap: {
show: false,
min: 80,
max: 600,
inRange: {
colorLightness: [0, 1]
}
},
series : [
{
name:'访问来源',
type:'pie',
radius : '55%',
center: ['50%', '50%'],
data:[
{value:335, name:'直接访问'},
{value:310, name:'邮件营销'},
{value:274, name:'联盟广告'},
{value:235, name:'视频广告'},
{value:400, name:'搜索引擎'}
].sort(function (a, b) { return a.value - b.value; }),
roseType: 'radius',
label: {
normal: {
textStyle: {
color: '#888'
}
}
},
labelLine: {
normal: {
lineStyle: {
color: '#888'
},
smooth: 0.2,
length: 10,
length2: 20
}
},
itemStyle: {
normal: {
color: '#c23531',
shadowBlur: 200,
shadowColor: 'rgba(0, 0, 0, 0.5)'
}
},
animationType: 'scale',
animationEasing: 'elasticOut',
animationDelay: function (idx) {
return Math.random() * 200;
}
}
]
}
chart.setOption(option, true)链接属性 link-type 值需要是 drawio 字符串。使用链接的形式也不会影响其他 Markdown 解析器解析。
drawio{link-type="drawio"}
链接属性 link-type 值需要是 luckysheet 字符串。使用链接的形式也不会影响其他 Markdown 解析器解析。
Warning
现阶段 Luckysheet Bug 较多，使用需谨慎。
luckysheet{link-type="luckysheet"}
支持类似 VuePress 容器块 功能，使用 markdown-it-container 实现
使用
::: <type> [title]
[content]
:::type 是必需的， title 和 content 是可选的。
支持的 type 有：tip, warning, danger, details, code-group, group, group-item, row, col, section, div
示例
::: tip 这是一个提示 :::
::: warning 这是一个警告 :::
::: danger 这是一个危险警告 :::
::: danger STOP 危险区域，禁止通行 :::
::: details 这是一个 details 标签 :::
::: details 点击展开更多 这是一个 details 标签 :::
:::: group 这是标签组 ::: group-item Tab 1 test 1 :::
::: group-item *Tab 2
test 2
标题前带 * 表示默认激活此选项卡
:::
::: group-item Tab 3 test 3 ::: ::::
::: code-group
let a = 1let a: number = 1:::
::::: row 分列示例 :::: col TODO ::: warning Item 1 ::: ::: warning Item 2 ::: ::: warning Item 3 ::: :::: :::: col DONE ::: tip Item 4 ::: ::: tip Item 5 ::: :::: :::::
:::: row ::: col Column 1 test 1 ::: ::: col Column 2 test 2 ::: ::: col Column 3 test 3 ::: ::::
Yank Note 接入了 OpenAI、Google AI 等人工智能平台，可以使用人工智能进行智能补全、文本重写等功能
Note
相关 API token 需要你自行获取。且需要 安装并启用 AI Copilot 扩展
页面支持类似 Jekyll Front Matter 配置信息
内置变量
| 变量名 | 类型 | 描述 |
|---|---|---|
headingNumber |
boolean |
是否开启页面标题序号编号 |
wrapCode |
boolean |
是否开启代码换行 |
enableMacro |
boolean |
是否开启宏替换 |
define |
Record<string, string> |
宏定义，定义文本替换 |
tags |
string[] |
文档标签 |
defaultPreviewer |
string |
文档默认的预览器，某些扩展可能提供特殊的预览界面。如 Reveal.js 扩展 |
mdOptions |
Record<string, boolean> |
Markdown-it 解析参数 |
mdOptions.html |
boolean |
开启 HTML 解析 |
mdOptions.breaks |
boolean |
转换 \n 成 <br> |
mdOptions.linkify |
boolean |
自动转换链接 |
mdOptions.typographer |
boolean |
开启语言替换和引号美化 |
katex |
Record<string, any> |
Katex 配置 |
Note
此功能 高级版可用
Yank Note 允许你在页面中嵌入宏，用以动态地替换文档。
Important
使用前需要先在 Front Matter 开启宏替换，定义 enableMacro: true。
Warning
使用宏替换可能会导致源码和预览行号对应不准确，Yank Note 已经尽可能处理，但某些情况可能仍然会出现同步滚动异常。
Front Matter 中的 define 字段可以定义一些文本替换映射。支持在另一个文件定义，支持宏表达式。具体可参考本文件顶部 Front Matter 部分。
Tip
你还可以在设置中配置 全局宏替换 ，这样所有文档都可以使用。不过，你仍然需要在 Front Matter 中定义 enableMacro: true。
- 应用名: --APP_NAME--
- 应用版本: --APP_VERSION--
- 另一个文件的定义: --TEST_DEFINE--
语法：
[= <expression> =]其中 expression 是需要执行的 js 表达式，支持 await/Promise 异步表达式。
如果表达式中需要包含 [= 或 =] 请输入 [\= 或 =\] 转义替换
- 是否开启页面标题序号编号: [= headingNumber =]
- 使用变量: [= customVar =]
- 定义变量: [= $export('testVar', 'Test') =][= testVar =]
- 定义函数: [= $export('format', (a, b) =>
${a}, ${b}!) =][= format('HELLO', 'WORLD') =] - 进一步处理: XXXXXXXXXXXXXX [= $afterMacro(src => src.replace(/X{4,}/g, 'YYYYY')) =]
- 应用版本：[= $ctx.version =]
- 当前文档名: [= $doc.basename =]
- 当前时间: [= $ctx.lib.dayjs().format('YYYY-MM-DD HH:mm') =]
- 计数器: [= $seq
图-=] | [= $seq图-=] | [= $seq图-=] | [= $seq表-=] | [= $seq表-=] - 限定符转义: [= '[= =]' =]
- 四则运算: [= (1 + 2) / 2 =]
- 引用文件（支持最多嵌套 3 层，可使用目标文档中定义的 Front Matter 变量)
[= $include('./_FRAGMENT.md', true) =]
- 被引用文档中定义的变量：[= customVarFromOtherDoc =]
- 你的 IP 地址：[= fetch('https://ifconfig.me/ip').then(r => r.text()) =]
- 天气预报
[= await ctx.utils.sleep(1000), fetch('https://wttr.in?0AT').then(r => r.text()) =] - 九九乘法表 [= (function nine (num) { let res = '' for (let i = 1; i <= num; i++) { let str = ''; for (let k = 1; k <= num; k++) { if (i >= k) { str += k + 'x' + i + '=' + i*k + ' '; } } res = res + str + '\n' } return res })(9) =]
宏表达式可以使用在 Front Matter 定义的变量，也可以使用下面的内置变量
| 变量名 | 类型 | 描述 |
|---|---|---|
$ctx |
object |
编辑器 ctx，可参考插件开发指南 和Api 文档
|
$include |
(path: string, trim = false) => Result |
引入其他文档片段方法 |
$export |
(key: string, val: any) => Result |
定义一个本文档可以使用的变量 |
$noop |
() => Result |
无操作函数，可用于文本占位使用 |
$afterMacro |
(fn: (src: string) => string) => Result |
定义一个宏替换后的回调函数，可用于对替换后的文本进行进一步处理。 |
$seq |
(label: string) => Result |
文档内部计数器 |
$doc |
object |
当前文档信息 |
$doc.basename |
string |
当前文档文件名（无后缀） |
$doc.name |
string |
当前文档文件名 |
$doc.path |
string |
当前文档路径 |
$doc.repo |
string |
当前文档仓库 |
$doc.content |
string |
当前文档内容 |
$doc.status |
'loaded', 'save-failed', 'saved' |
当前文档状态 |
在向别人交接文档的时候，可以使用脚本，自定义命令行参数启动程序，方便对方查看文档。
| 名称 | 作用 | 默认值 | 说明 | 示例 |
|---|---|---|---|---|
| --port | 服务器监听端口 | 3044 | 端口 | --port=8080 |
| --disable-tray | 禁用常驻托盘 | false | true/false | --disable-tray |
| --readonly | 编辑器只读 | false | true/false | --readonly |
| --show-status-bar | 显示状态栏 | true | true/false | --show-status-bar=false |
| --data-dir | 数据目录 | 无 | 目录路径字符串 | --data-dir='./.data' |
| --init-repo | 初始仓库名 | 无 | 字符串 | --init-repo='test' |
| --init-file | 加载文件路径 | 无 | 文件路径，相对于仓库路径 | --init-file='/1.md' |
- 右键点击托盘图标，点击“打开主目录”，进入
<主目录>/themes目录。 - 复制
github.css为一个新 CSS 文件，修改 CSS 内容 - 打开设置 => 外观 => 自定义 CSS 切换 CSS 配置
请参考插件开发指南