Skip to content

name-jerry/MySite

Repository files navigation

MySite

  • 一个简单的首页,有个人计划,在线编写markdown文档,点击首页右上角设置,选择上传模块,将md文档拖入其中上传,即可实现本地的编辑,具体编写功能见下 详见.
  • md解析基于markdown-it引擎实现,大部分功能和官方一致,以下是个人对常用功能的总结,以及部分和官方不一致的地方,官方详见.

基础功能

基础简写 说明
标题(# title) 注意有空格,符号个数表示标题级别等同<h1></h1>
段落 空白行后跟文字,不要用空白行和制表符缩进,等同<p></p>
换行 在一行的末尾添加两个或多个空格,然后按回车键,即可创建一个
强调(*) 加粗**string**,斜体*string*,加粗斜体***string***
引用(>空格string) 多行引用时注意段落和段落之间的空白行也要加>,嵌套引用>>
有序列表(number.空格string)1 两个tab或四个空格缩进可表示嵌套,等同<ol><li></li></ol>
无序列表(-或*或+空格string))1 两个tab或四个空格缩进可表示嵌套,等同<ul><li></li></ul>
代码(`) 如果code中有`则外部使用``code``
代码块 四个空格或则一个制表符,在列表中时需要8个空格或2个制表符
分割线 空白行***或---或___空白行
链接[]() [超链接显示名](超链接地址 "超链接title"),title可选对应的HTML代码:<a href="超链接地址" title="超链接title">超链接显示名</a>
引用链接 [超链接显示名][标签],在文章底部[标签]: url "title"(url中的空格使用(%20表示),将链接分成两部分
链接简写<> <email或url>
图片![]() ![图片alt](图片链接 "图片title")等同<img src="图片链接" alt="图片alt" title="图片title">
图片加链接(图片外嵌套链接) [![沙漠中的岩石图片](/assets/img/shiprock.jpg "Shiprock")](https://markdown.com.cn)
转义字符\ 用于显示保留字符,字符< 和 &将被自动转义
内嵌html标签 内联标签能解析元素中markdown语法,区块标签前后加空白行,不要缩进,内部不能解析其中markdown语法
常用html标签 details可折叠,summary标题,搭配代码块使用可以缩减文章篇幅

扩展

扩展简写 说明
表格 快捷输入[^table]table3*3使用三个或多个连字符(---)创建每列的标题,并使用管道(竖)分隔每列。连字符的左侧,右侧或两侧添加冒号(:),将列中的文本对齐到左侧,右侧或中心
代码块 前后行使用``` 或~~~替代原来的需要的4个空格,同时可在前行连字符后面加上标记语言类型用于采用相应的高亮显示
引用脚注 [^标签]],被引用处[^标签]]: 解释,被引用会自动排版到文档最下面
内联脚注 ^[解释],表现结果和引用脚注一样
删除线 ~~string~~
复选框 -空格[空格],选中的复选框-空格[x]
Emoji表情 使用emoji shortcodes
*[缩写]: 全称 对一个缩写定义全称,使用该缩写时 空格缩写空格
马克笔(==) ==string==加载效果等同<mark>string</mark>
上下标 ^上标^ ~下标~
换页符 空行加一行---再加一行---,在打印时表现为强制换页,平时表示为上下内容距离加宽,部分浏览器还会显示出一个分割线

已启用功能

功能 简介
同屏 是否同时显示编辑和预览区

已启用快捷方式

功能 快捷键
切换编辑预览 C+a 同屏时无效
保存 C+s
下载 C+d

*[C]: ctrl

已启用代码联想功能s

提示出现后按tab键输入

代码 触发简写
img 图片
a 标签
code 代码块
table数字*数字 列表

未启用

未启用拓展 说明
目录([[toc]]) 原来是可在任何地方生成目录,目前已设置成自动生成,如果继续填写会重复生成表格堆叠在左上角,遇到现实不正常的,在md文件最后结尾加两个空行就行
{.或#或attr=string} 加属性,使用者基本用不到,就没启用了
描述列表 title换行:空格 描述
自动转url链接 为了避免不必要的转换就没启用了,如果有自动转换的,可以在url前后加``将其解读为代码片段

Footnotes

  1. markdown原文档嵌套只用一个tab或两个空格,这里用的markdown-it引擎必须要两个tab或四个空格 2