Skip to content

cayole/how-to-use-md

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 

Repository files navigation

MARKEDOWN

轻量级标记语言


TIP;Ctrl+。可以切换中英标点符号

一、多级标题

依次缩进,共六级

一级标题

二级标题

三级标题

二、字体

斜体or粗体

斜体 粗体 粗斜体

快捷键 加粗Ctrl+B 斜体Ctrl+I

三、换行

直接在一句话后敲两个空格
两句话之间加一个空行

如果你在编辑的时候,想让一行文字在显示的时候换行
,就在中间加br/.

四、引用

引用

嵌套引用

呃呃

五、链接

链接名称 <链接地址>

好东西 or https://www.roxylib.com/

六、图片

图片描述,可写可不写,但是中括号要有

也是好东西 最好在一个文件夹里

![][ / 图片名.图片格式]转化为<img src = 文件名 . 图 片格式 / 切换PDF

七、列表

无序列表,使用*、+、-,再加一个空格作为列表的标记

有序列表,使用数字并加上.号,再加一个空格作为列表的标记

代码:

  • part one
  • part two
    • inside part
      • TAB向右缩进

代码:

  1. 部分A
  2. 部分B
    1. 内部内容TAB

八、杂项

分割线


写分割线前,要空一行之后写,否则会导致前一行字体放大





删除线


这是要被删除的文字

下划线


这行文字已被添加下划线

代码块


如果在一行内需要引用代码,只需要用反引号`引起来就好了。

Hello World.


如果是在一个块内需要引用代码,则在需要引用的代码块的前一行和后一行使用三个反引号,同时在前一个反引号后写入代码的语言。

支持以下语言bash,c,clojure,cpp,cs,css,dart,dockerfile, diff,erlang,go,gradle,groovy,haskell,java,javascript,json,julia,kotlin,lisp,lua,makefile,markdown,matlab,objectivec,perl,php,python,r,ruby,rust,scala,shell,sql,swift,tex,typescript,verilog,vhdl,xml,yaml

#include<stdio.h>
int main (void)
{
    printf("fuck you");
    return 0;
}

脚注


  • 使用 Markdown1可以效率的书写文档, 直接转换成 HTML2, 你可以使用 Typora3 编辑器进行书写。

特殊符号


对于Markdown中的语法符号,前面家反斜线\即可以显示符号本身

\
*
_
+
.

表格


  • 表格使用|来分割不同的单元格,使用-来分隔表头和其他行
    • :- 将表头及单元格内容左对齐
    • -: 将表头及单元格内容右对齐
    • :-: 将表头及单元格内容居中
项目 价格 数量
计算机 $1600 5
手机 $12 12
管线 $1 234

九、高级用法

支持HTML元素

使用 Ctrl+Alt+Del 摸鱼

代办事项

我们可以使用Markdown来制作一个待办事项,格式为、-[] 表示未完成;-[x]表示已完成

  • 摸鱼
  • 摸鱼鱼

书写公式

可以使用 2个美元符 $ 包裹 TeX 或 LaTeX 格式的数学公式来实现。 /$$表示整行公式
E = m c 2

上标使用符号 ^ 包围、下标使用符号 ~ 包围。编辑器不支持时,可分别使用 HTML 标签 6(superscript)和 6(subscript)替代。

绘制图

流程图

graph TD;
A-->B
A-->C
B-->D
C-->B
C-->D
Loading

graph TB
 
  id1(圆角矩形)--普通线-->id2[矩形];
  subgraph 子图
   id2==粗线==>id3{菱形}
   id3-.虚线.->id4>右向旗帜]
   id3--无箭头---id5((圆形))
  end
Loading

时序图

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!
Loading

甘特图

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
Loading

饼图

pie
 
  title Key elements in Product X
  "Calcium" : 42.96
  "Potassium" : 50.05
  "Magnesium" : 10.01
  "Iron" :  5
Loading

状态图

stateDiagram
 
    [*]-->Active
    state Active {
        [*]-->NumLockOff
        NumLockOff-->NumLockOn : EvNumLockPressed
        NumLockOn-->NumLockOff : EvNumLockPressed
        --
        [*]-->CapsLockOff
        CapsLockOff-->CapsLockOn : EvCapsLockPressed
        CapsLockOn-->CapsLockOff : EvCapsLockPressed
        --
        [*]-->ScrollLockOff
        ScrollLockOff-->ScrollLockOn : EvCapsLockPressed
        ScrollLockOn-->ScrollLockOff : EvCapsLockPressed
            }
Loading

类别图

classDiagram
 
  Class01 <|-- AveryLongClass: Cool
  <<interface>> Class01
  Class09-->C2: Where am i?
  Class09 --* C3
  Class09 --|> Class07
  Class07: equals()
  Class07: Object[] elementData
  Class01: size()
  Class01: int chimp
  Class01: int gorilla
  class Class10 {
    <<service>>
    int id
    size()
  }
Loading

实体关系图

erDiagram
    CUSTOMER ||--o{ ORDER : places
    ORDER ||--|{ LINE-ITEM : contains
    CUSTOMER }|..|{ DELIVERY-ADDRESS : uses
Loading

Footnotes

  1. Markdown是一种纯文本标记语言

  2. HyperText Markup Language 超文本标记语言

  3. NEW WAY TO READ & WRITE MARKDOWN.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published