最近正在学习markdown语法,同时也在接触github.
下面是一些细碎的学习markdown的笔记,自己写的,对我自己很有用的.
好记性不如烂笔头,所以,可以借由笔记,借由qiita的平台,留下一点学习的足迹.
文中有好些自创的名词,句子,格式,...
如果有哪位朋友正在看,请不要对这些自创的玩意感到"困惑"...跳过去就是了,
或者也可以在评论区提问:)
目前markdown有各种标准,头都有点晕了.
本篇的笔记,主要以传统的markdown标准为规范,并参考了很多github的markdown规范.
其他类型的markdown规范,暂不涉及.
这里的第一篇笔记,自己写给自己看的,所以很随性.并且也主要用来测试这个网站和社区的初步使用体验.
很粗疏,挺"杂"的.请海涵.请轻拍.
斜体 i
Spring is coming...
加粗 B 推荐...
I like spring.
A 数字标识(正常) 推荐...
1. Spring
-
Summer
-
Fall
a 主实 句点标识 推荐...
(由单星*加单空格置首实现.实际显示效果比数字标识退两格...并且默认首标识开头与上文空一行)
(星号与单词之间无空格则视为普通表达)
-
spring
-
summer
-
fall
a1 副空 句点标识 (行首空两格. 必须联合 主实句点 使用) 推荐...
(两个以上主副句点联排时,联排之间必须换行...重要)
-
spring
-
beijing
第二个主副句点联排,上面已经空了一行.
-
summer
- hongkong
实句点 空句点 的表达也可以用 - 实现(与 * 等效) 推荐...
-
fall
- boston
---------------------------------------下面语法在 作业部落的 cmd-markdown编辑器中编辑的
-
文本斜体两种方式A A
-A-(减号不能实现加粗和斜体)...
-
文本加粗两种方式A A
- 副级空句点
- 副级空句点第二种方式
_ 副级空句点(下划线不能实现空句点)...
-
总之:
粗体 斜体 两种方式: * _(下划线)
主实句点 副空句点 3种方式: * + -(减号) 无序列表
所以: 推荐用*实现 粗体 斜体
推荐用 - 实现无序列表的虚实句点,相应地,用 _ 实现粗体(或者用*也行)
主句点默认首行与上文空一行.并且默认下文首行都空两格.
-
若 * + _ - 两边都有空白,则联通空白一起被视作普通字符.
-
单行减号是分隔符.双行减号产生单行原样.
- 插入图片链接: 推荐...
-
上顿号`的长短背景作用.(首尾各3个上顿号用作代码背景和高亮)
-
给文字添加淡色背景采用两边各一个上顿号,例如:
轻轻显明
-
#的标题作用以及强制换行作用
-
一级标题采用一个
#
(并且务必紧跟一个空格)...依次类推.
(推荐标识符与右边文字有一个空格..当然不空格也可以.) 推荐...
时光
四季
春天
初春
......
秋天(文字下面一行,只要放减号,就对文字产生2级标题效果) ...推荐...
独立行独立等号=也对上文产生1级标题效果
=
秋天
秋天 (1级大粗效果,最少用)
秋天 (2级标题大粗效果,第二常用)
秋天 (3级标题加粗和放大效果, 最常用! )
秋天 (4级标题,等同加粗,不过整行都加粗了...)
- 因为markdown默认手动换行只1行有效, 所以想要实际显示更多空行, 需要:
1个#再加1个 空格,可以指定2个空行: (清除上下格式影响,强制分行)
文本开始,按回车N次,只显示1个空行:
这下OK了, #加1个空格, 在实际中产生了2个空行.
- 引用诗人的佳作
>
. (要脱离>的引用范围必须手动换行...重要)
好雨知时节,当春乃发生;
随风潜入夜,润物细无声.
--- 杜甫 (要脱离>的引用范围必须手动换行...重要)
-
三个
-
号可组成短直线,如上杜甫... -
文本加粗和斜体
-
清单List--->
-
插入图片--->
-
各级标题, 引用, 加淡色背景, 短直线, 箭头--->
-
插入代码--->
-
其他:
-
上顿号`的作用:
-
给文字添加淡色背景采用两边各一个上顿号,例如:
轻轻显明
-
首尾用1个上顿号紧联可能产生的效果:
` int a=3;
int b=5;
int c=6; `
-
插入代码:
-
融合嵌入不高亮,采用淡色背景: 文字中嵌入
int a=0
,就是这样子. -
独立嵌入不高亮, 采用先空一行,再第一行行首缩进8格就可
(用2个TAB键方便): --->此为法一 int a=0; int b=1;
-
独立嵌入不高亮, 采用首尾各3个上顿号: --->此为法二
-
int a=3;
int b=5;
- 独立嵌入并且高亮,采用上顿号和编程语言说明:
int a=3;
int b=5;
printf("春天来啦!\n");
- 自动的*或#,可以采用2次enter键消除.复原.
-
洗衣服已经完成.
-
还没开始炒菜.
- github特殊处
-
嵌入emoji:(目前貌似只有github的markdown才可以支持彩色表情)
sparkles:
-
github特殊还有: Hello@yichenruolan - I like you.也可以mention团队名
(对方会接到来这边看的消息...类似知乎,微博)
-
托管的代码序号自动生成链接
-
Issue references within a repository(库内问题和消息自动链接格式:)
Any number that refers to an Issue or Pull Request will be automatically converted into a link.
1
mojombo#1
mojombo/github-flavored-markdown#1
- Certain references are auto-linked:
-
SHA: a5c3785ed8d6a35868bc169f07e40e889087fd2e
-
User@SHA: jlord@a5c3785ed8d6a35868bc169f07e40e889087fd2e
-
User/Repository@SHA: jlord/sheetsee.js@a5c3785ed8d6a35868bc169f07e40e889087fd2e
-
#Num: #26
-
GH-Num: GH-26
-
User#Num: jlord#26
-
User/Repository#Num: jlord/sheetsee.js#26
becomes
SHA: a5c3785
User@SHA: jlord@a5c3785
User/Project@SHA: jlord/sheetsee.js@a5c3785
Num: #26
GH-Num: GH-26
User#Num: jlord#26
User/Project#Num: jlord/sheetsee.js#26
- Quick quoting
Typing r on your keyboard lets you reply to the current issue or pull request with a comment. Any text you select within the discussion thread before pressing r will be added to your comment automatically and formatted as a blockquote.
- Issue autocompletion
Typing # will bring up a list of suggested Issues and Pull Requests. Type a number or some text to filter the list, then hit either tab or enter to complete the highlighted result.
-
图片链接:
(最好是一切按照规范格式来.比如上面的右中括号和左小括号之间按照规范是不能有空格的)
-
链接:
方法二: 知乎
-
markdown文件常见结尾有: 文件.md 文件.markdown
-
表格(开始前,必须空一行)
(作业部落的cmd 小书匠 markble stackedit的表格支持还不错,为知笔记则差)
(在每行首末都再加上|也可以,不影响.所以也可不加)
朝代|姓名|职位
-|-|-
三国|刘备|蜀国皇帝
唐|魏征|丞相
宋|岳飞|将军
- 表格再加:,放左居左,放右居右,左右都放,则居中.
朝代|姓名|职位
:-|:-:|-:
三国|刘备|蜀国皇帝
唐|魏征|丞相
宋|岳飞|将军
-
删除线 ~~ ~~
多余句子,可删
-
穿越时光
-
在想象中
-
在现实里
-
穿越空间
-
在想象中
- 在人的想象中
-
在现实中
- 在人类的现实世界里
-
+ -(减号) * 都可以用来表示无序列表
-
雅典
- 爱情海
-
巴黎
-
新德里
- 恒河
(单行减号线,成为分隔线)
(单行下划线,成为分隔线)
(1个减号,是实心句点. 2个减号,是原样. 3个减号或3个星号,是分隔线.) ...推荐...
(1个2个下划线,都是原样. 3个下划线,是分隔线)
春天---
(文字紧跟减号,原样)
-----夏天
(减号紧跟文字,原样)
秋天(文字下面一行,只要放减号,就对文字产生2级标题效果) ...可用...
独立行独立等号=也对上文产生1级标题效果
=
以上都是对-的讨论, _ 则除了单独用可用做分隔线外,其他保持原样. ...重要...
秋天 (1级大粗效果,最少用)
秋天 (2级标题大粗效果,第二常用)
秋天 (3级标题加粗和放大效果, 最常用! )
秋天 (4级标题,等同加粗,不过整行都加粗了...)
三级标题就是我
冬天
-
小动作,如加粗,斜体,标题...什么的,若要生效,一般不用考虑换行
-
唯独 无序列表 代码高亮 表格 ,需要最先换行,才能生效.
-
并且标题#,无序列表*,规范写法,需要紧跟一个空格.其他粗体斜体什么的,不需要空格.
-
对LaTeX直白数学公式的支持:
-
爱因斯坦智能守恒公式: (独立行,两个$符号) $$E=mc^2.$$
-
我来学数学: E=mc^2. 不错吧?
-
我来学物理: $E=mc^2$. 不错吧? (文中嵌入,一个$符号)
- 因为markdown默认手动换行只1行有效, 所以想要实际显示更多空行, 需要:
1个#再加1个 空格,可以指定一个空行: (清除上下格式影响,强制分行)
文本开始,按回车N次,只显示1个空行:
这下OK了, #加1个空格, 在实际中产生了1个空行.
- 列表下面的引用>,规范的做法是需要首行首先缩进4空格(1个TAB )
(虽然有的编辑器不缩进,也可以对引用显示缩进效果,比如本cmd编辑器)
-
杜甫写诗:
好雨知时节
当春乃发生
-
可惜作业部落的cmd和stackedit都不支持 完成清单. 只有小书匠和github支持.(列表符号-与链接符号[]的结合)
-[x] 洗衣服已经完成
-[ ] 炒菜还没开始
- 地址链接的两种形式: 完整式 索引式
一下讨论的都是网址链接.图片链接则同理,(只需在第一个[]前面加上感叹号!)
- 完整式链接--->
(可以加标题,可以不加标题):
- 索引式链接--->
- 说明:后面的[]里面可以是 数字 字母 空白(为空白时,就是 隐式链接)
然后比如可以在文件末尾写上链接的详细内容(索引):(其实索引可以写在文中任意的地方)
文末链接索引格式:
-
1之前可以缩进至多3个空格.
-
必须有冒号: (重要)
-
冒号:后面必须跟1个以上的空格或tab. (重要)
-
网址可以用<>括起来:
-
可以在网址后面写上标题,可以3种形式: (较重要)
-
"豆瓣网:尘世流连"
-
'豆瓣网:尘世流连'
-
(豆瓣网:尘世流连)
- 索引式链接之--->隐式链接(就是后面的[]里空白,等同于前面[]里的文字)
文中某处:
文末索引相应地变成:
-
自动链接形式:
-
反斜杠
*literal asterisks*
Markdown 支持以下这些符号前面加上反斜杠来帮助插入普通的符号:
\ 反斜线
` 反引号
- 星号
_ 底线
{} 花括号
[] 方括号
() 括弧
# 井字号
+ 加号
- 减号
. 英文句点
! 惊叹号
全文终:)