Markdown语法使用 网络编程 2021年7月12日 07:05 夏至未至 1585 当前内容 7659 字,在路上,马上到,马上到 # Markdown 语法众多,慢慢收集,慢慢总结 @基础模板来自其他网页 @(示例笔记本)[马克飞象|帮助|Markdown] **马克飞象**是一款专为印象笔记(Evernote)打造的Markdown编辑器,通过精心的设计与技术实现,配合印象笔记强大的存储和同步功能,带来前所未有的书写体验。特点概述: - **功能丰富** :支持高亮代码块、*LaTeX* 公式、流程图,本地图片以及附件上传,甚至截图粘贴,工作学习好帮手; - **得心应手** :简洁高效的编辑器,提供[桌面客户端][1]以及[离线Chrome App][2],支持移动端 Web; - **深度整合** :支持选择笔记本和添加标签,支持从印象笔记跳转编辑,轻松管理。 ------------------- [TOC] ## Markdown简介 > Markdown 是一种轻量级标记语言,它允许人们使用易读易写的纯文本格式编写文档,然后转换成格式丰富的HTML页面。 —— [维基百科](https://zh.wikipedia.org/wiki/Markdown) 正如您在阅读的这份文档,它使用简单的符号标识不同的标题,将某些文字标记为**粗体**或者*斜体*,创建一个[链接](http://www.example.com)或一个脚注[^demo]。下面列举了几个高级功能,更多语法请按`Ctrl + /`查看帮助。 ### 代码块 ```python @requires_authorization def somefunc(param1='', param2=0): '''A docstring''' if param1 > param2: # interesting print 'Greater' return (param2 - param1 + 1) or None class SomeClass: pass >>> message = '''interpreter ... prompt''' ``` ### 代码块2 @requires_authorization def somefunc(param1='', param2=0): '''A docstring''' if param1 > param2: # interesting print 'Greater' return (param2 - param1 + 1) or None class SomeClass: pass >>> message = '''interpreter ... prompt''' ### 代码块3 ```python @requires_authorization def somefunc(param1='', param2=0): '''A docstring''' if param1 > param2: # interesting print 'Greater' return (param2 - param1 + 1) or None class SomeClass: pass >>> message = '''interpreter ... prompt''' ``` ### LaTeX 公式 可以创建行内公式,例如 $\Gamma(n) = (n-1)!\quad\forall n\in\mathbb N$。或者块级公式: $$ x = \dfrac{-b \pm \sqrt{b^2 - 4ac}}{2a} $$ ### 表格 | Item | Value | Qty | | :-------- | --------:| :--: | | Computer | 1600 USD | 5 | | Phone | 12 USD | 12 | | Pipe | 1 USD | 234 | ### 流程图 ```flow st=>start: Start e=>end op=>operation: My Operation cond=>condition: Yes or No? st->op->cond cond(yes)->e cond(no)->op ``` 以及时序图: ```sequence Alice->Bob: Hello Bob, how are you? Note right of Bob: Bob thinks Bob-->Alice: I am good thanks! ``` > **提示:**想了解更多,请查看**流程图**[语法][3]以及**时序图**[语法][4]。 ### 类图 ```mermaid classDiagram class 动物 动物 : String 标签 动物 : 吃() ``` ### 复选框 使用 `- [ ]` 和 `- [x]` 语法可以创建复选框,实现 todo-list 等功能。例如: - [x] 已完成事项 - [ ] 待办事项1 - [ ] 待办事项2 > **注意:**目前支持尚不完全,在印象笔记中勾选复选框是无效、不能同步的,所以必须在**马克飞象**中修改 Markdown 原文才可生效。下个版本将会全面支持。 ## 印象笔记相关 ### 笔记本和标签 **马克飞象**增加了`@(笔记本)[标签A|标签B]`语法, 以选择笔记本和添加标签。 **绑定账号后**, 输入`(`自动会出现笔记本列表,请从中选择。 ### 笔记标题 **马克飞象**会自动使用文档内出现的第一个标题作为笔记标题。例如本文,就是第一行的 `欢迎使用马克飞象`。 ### 快捷编辑 保存在印象笔记中的笔记,右上角会有一个红色的编辑按钮,点击后会回到**马克飞象**中打开并编辑该笔记。 >**注意:**目前用户在印象笔记中单方面做的任何修改,马克飞象是无法自动感知和更新的。所以请务必回到马克飞象编辑。 ### 数据同步 **马克飞象**通过**将Markdown原文以隐藏内容保存在笔记中**的精妙设计,实现了对Markdown的存储和再次编辑。既解决了其他产品只是单向导出HTML的单薄,又规避了服务端存储Markdown带来的隐私安全问题。这样,服务端仅作为对印象笔记 API调用和数据转换之用。 >**隐私声明:用户所有的笔记数据,均保存在印象笔记中。马克飞象不存储用户的任何笔记数据。** ### 离线存储 **马克飞象**使用浏览器离线存储将内容实时保存在本地,不必担心网络断掉或浏览器崩溃。为了节省空间和避免冲突,已同步至印象笔记并且不再修改的笔记将删除部分本地缓存,不过依然可以随时通过`文档管理`打开。 > **注意:**虽然浏览器存储大部分时候都比较可靠,但印象笔记作为专业云存储,更值得信赖。以防万一,**请务必经常及时同步到印象笔记**。 ## 编辑器相关 ### 设置 右侧系统菜单(快捷键`Ctrl + M`)的`设置`中,提供了界面字体、字号、自定义CSS、vim/emacs 键盘模式等高级选项。 ### 快捷键 帮助 `Ctrl + /` 同步文档 `Ctrl + S` 创建文档 `Ctrl + Alt + N` 最大化编辑器 `Ctrl + Enter` 预览文档 `Ctrl + Alt + Enter` 文档管理 `Ctrl + O` 系统菜单 `Ctrl + M` 加粗 `Ctrl + B` 插入图片 `Ctrl + G` 插入链接 `Ctrl + L` 提升标题 `Ctrl + H` ## 关于收费 **马克飞象**为新用户提供 10 天的试用期,试用期过后需要[续费](maxiang.info/vip.html)才能继续使用。未购买或者未及时续费,将不能同步新的笔记。之前保存过的笔记依然可以编辑。 ## 反馈与建议 - 微博:[@马克飞象](http://weibo.com/u/2788354117),[@GGock](http://weibo.com/ggock "开发者个人账号") - 邮箱: --------- 感谢阅读这份帮助文档。请点击右上角,绑定印象笔记账号,开启全新的记录与分享体验吧。 [^demo]: 这是一个示例脚注。请查阅 [MultiMarkdown 文档](https://github.com/fletcher/MultiMarkdown/wiki/MultiMarkdown-Syntax-Guide#footnotes) 关于脚注的说明。 **限制:** 印象笔记的笔记内容使用 [ENML][5] 格式,基于 HTML,但是不支持某些标签和属性,例如id,这就导致`脚注`和`TOC`无法正常点击。 [1]: http://maxiang.info/client_zh [2]: https://chrome.google.com/webstore/detail/kidnkfckhbdkfgbicccmdggmpgogehop [3]: http://adrai.github.io/flowchart.js/ [4]: http://bramp.github.io/js-sequence-diagrams/ [5]: https://dev.yinxiang.com/doc/articles/enml.php 欢迎使用马克飞象 示例笔记本 马克飞象 帮助 Markdown 马克飞象是一款专为印象笔记(Evernote)打造的Markdown编辑器,通过精心的设计与技术实现,配合印象笔记强大的存储和同步功能,带来前所未有的书写体验。特点概述: 功能丰富 :支持高亮代码块、LaTeX 公式、流程图,本地图片以及附件上传,甚至截图粘贴,工作学习好帮手; 得心应手 :简洁高效的编辑器,提供桌面客户端以及离线Chrome App,支持移动端 Web; 深度整合 :支持选择笔记本和添加标签,支持从印象笔记跳转编辑,轻松管理。 欢迎使用马克飞象 Markdown简介 代码块 LaTeX 公式 表格 流程图 复选框 印象笔记相关 笔记本和标签 笔记标题 快捷编辑 数据同步 离线存储 编辑器相关 设置 快捷键 关于收费 反馈与建议 Markdown简介 Markdown 是一种轻量级标记语言,它允许人们使用易读易写的纯文本格式编写文档,然后转换成格式丰富的HTML页面。 —— 维基百科 正如您在阅读的这份文档,它使用简单的符号标识不同的标题,将某些文字标记为粗体或者斜体,创建一个链接或一个脚注1。下面列举了几个高级功能,更多语法请按Ctrl + /查看帮助。 代码块 @requires_authorization def somefunc(param1='', param2=0): '''A docstring''' if param1 > param2: # interesting print 'Greater' return (param2 - param1 + 1) or None class SomeClass: pass >>> message = '''interpreter ... prompt''' LaTeX 公式 可以创建行内公式,例如 。或者块级公式: 表格 Item Value Qty Computer 1600 USD 5 Phone 12 USD 12 Pipe 1 USD 234 流程图 Start My Operation Yes or No? End yes no 以及时序图: Alice Alice Bob Bob Hello Bob, how are you? Bob thinks I am good thanks! 提示:想了解更多,请查看流程图语法以及时序图语法。 复选框 使用 - [ ] 和 - [x] 语法可以创建复选框,实现 todo-list 等功能。例如: 已完成事项 待办事项1 待办事项2 注意:目前支持尚不完全,在印象笔记中勾选复选框是无效、不能同步的,所以必须在马克飞象中修改 Markdown 原文才可生效。下个版本将会全面支持。 印象笔记相关 笔记本和标签 马克飞象增加了@(笔记本)[标签A|标签B]语法, 以选择笔记本和添加标签。 绑定账号后, 输入(自动会出现笔记本列表,请从中选择。 笔记标题 马克飞象会自动使用文档内出现的第一个标题作为笔记标题。例如本文,就是第一行的 欢迎使用马克飞象。 快捷编辑 保存在印象笔记中的笔记,右上角会有一个红色的编辑按钮,点击后会回到马克飞象中打开并编辑该笔记。 注意:目前用户在印象笔记中单方面做的任何修改,马克飞象是无法自动感知和更新的。所以请务必回到马克飞象编辑。 数据同步 马克飞象通过将Markdown原文以隐藏内容保存在笔记中的精妙设计,实现了对Markdown的存储和再次编辑。既解决了其他产品只是单向导出HTML的单薄,又规避了服务端存储Markdown带来的隐私安全问题。这样,服务端仅作为对印象笔记 API调用和数据转换之用。 隐私声明:用户所有的笔记数据,均保存在印象笔记中。马克飞象不存储用户的任何笔记数据。 离线存储 马克飞象使用浏览器离线存储将内容实时保存在本地,不必担心网络断掉或浏览器崩溃。为了节省空间和避免冲突,已同步至印象笔记并且不再修改的笔记将删除部分本地缓存,不过依然可以随时通过文档管理打开。 注意:虽然浏览器存储大部分时候都比较可靠,但印象笔记作为专业云存储,更值得信赖。以防万一,请务必经常及时同步到印象笔记。 编辑器相关 设置 右侧系统菜单(快捷键Ctrl + M)的设置中,提供了界面字体、字号、自定义CSS、vim/emacs 键盘模式等高级选项。 快捷键 帮助 Ctrl + / 同步文档 Ctrl + S 创建文档 Ctrl + Alt + N 最大化编辑器 Ctrl + Enter 预览文档 Ctrl + Alt + Enter 文档管理 Ctrl + O 系统菜单 Ctrl + M 加粗 Ctrl + B 插入图片 Ctrl + G 插入链接 Ctrl + L 提升标题 Ctrl + H 关于收费 马克飞象为新用户提供 10 天的试用期,试用期过后需要续费才能继续使用。未购买或者未及时续费,将不能同步新的笔记。之前保存过的笔记依然可以编辑。 反馈与建议 微博:@马克飞象,@GGock 邮箱:hustgock@gmail.com 感谢阅读这份帮助文档。请点击右上角,绑定印象笔记账号,开启全新的记录与分享体验吧。 这是一个示例脚注。请查阅 MultiMarkdown 文档 关于脚注的说明。 限制: 印象笔记的笔记内容使用 ENML 格式,基于 HTML,但是不支持某些标签和属性,例如id,这就导致脚注和TOC无法正常点击。 ↩ 绑定印象笔记账号 绑定 Evernote International 账号 当前文档 恢复至上次同步状态 删除文档 导出... 预览文档 分享链接 系统 设置 下载桌面客户端 下载离线Chrome App 使用说明 快捷帮助 常见问题 关于 搜索文件 强调 *斜体* **粗体** CtrlI/B 链接 [描述](http://example.com) CtrlL 图片 CtrlG 笔记本 @(笔记本)[标签1,标签2,标签3] 标题 标题1 标题2 ======== -------- ## 标题2 ###### 标题6 Ctrl1~5 列表 1. 有序列表 - 无序列表 - [ ] 复选框 2. 有序列表 - 无序列表 - [x] 复选框 引用 > 这是引用的文字 > 引用内可以嵌套标题、列表等 代码 这是一句行内代码 `var a=1` , 以下是代码区块: ```ruby print 'Hello world' ``` CtrlK LaTex 公式 这是一句行内公式 $ y = x + 1 $ , 以下是整行公式: $$ a^2 + b^2 = c^2 $$ 表格 | Item | Value | Qty | | :-------- | --------:| :--: | | Computer | 1600 USD | 5 | CtrlAltT 文档管理 CtrlO 帮助 Ctrl/ 最大化编辑器 CtrlEnter 预览文档 CtrlAltEnter 同步文档 CtrlS 创建文档 CtrlAltN 系统菜单 CtrlM 图片管道指令 ![@描述 | left | 300x0]() @描述 @会将描述显示在图片下方 left 左侧对齐 right 右侧对齐 center 居中 300x200 宽x高, 0代表自适应 本文标题: Markdown语法使用 本文作者: 夏至未至 发布时间: 2021年7月12日 07:05 最近更新: 2022年2月28日 09:39 原文链接: 许可协议: 署名-非商业性-禁止演绎 4.0 国际(CC BY-NC-ND 4.0) 请按协议转载并保留原文链接及作者 Markdown语法(1) 上一个 VS系列控制台闪退解决 下一个 TCP和UDP的最完整的区别 当前文章评论暂未开放,请移步至留言处留言。