zoukankan      html  css  js  c++  java
  • Markdown语法和工具推荐

    对于硕士研究生的我们做笔记,写文章是必备的技能,经过半年有余的研究生生活,我发现了几种比较好用的编辑工具,这里针对Markdown简单介绍一下,因为学习过程是学生的必经之路,我们应该学会站在巨人的肩膀上,所以学会做笔记是第一步啊!值得一提的是文章中用到了Latex公式语法,这也是一个比较好用的写论文的工具,当然你会问我为什么会选择使用Markdown语言,因为Markdown比较容易上手并且个人认为更适合于撰写notebook,当然在Git hub上有很多牛人选择Markdown进行书籍的撰写,不得不说Markdown真是写手的一大利器。下面就跟大家讲解其使用方法,相信你们一定会喜欢上Markdown的。

    一、标题

    # 一级标题
    ## 二级标题
    ### 三级标题
    

    效果如下

    一级标题

    二级标题

    三级标题


    二、引用

    > 这里是引用,我一般用来写一些解释性的东西比如名词的含义,或者添加一些附录性的信息,如下
    >
    >相关工具推荐:
    >
    >Markdown在线编辑工具:**[dillinger](https://dillinger.io/)**、**[Cmd Markdown](https://www.zybuluo.com/mdeditor)**
    >
    >Markdown离线编辑工具:**[Typora](http://typora.io/)**、**[印象笔记](https://www.yinxiang.com/?utm_source=yinxiang_app&utm_medium=windows)**、**[MarkdownPad](http://markdownpad.com/)**
    >
    >Markdown离线PowerPoint工具:**[Marp](https://yhatt.github.io/marp/)**
    >
    >论文排版利器:**[LaTeX](https://en.wikibooks.org/wiki/LaTeX)**
    >
    >PowerPoint的LaTex加载项工具:**[IguanaTex](http://www.jonathanleroux.org/software/iguanatex/)**
    >
    >公式image转LaTex工具:**[mathpix](https://mathpix.com/)**
    

    效果如下

    相关工具推荐:

    Markdown在线编辑工具:dillingerCmd Markdown
    Markdown离线编辑工具:Typora印象笔记MarkdownPad
    Markdown离线PowerPoint工具:Marp
    论文排版利器:LaTeX
    PowerPoint的LaTex加载项工具:IguanaTex
    公式image转LaTex工具:mathpix

    三、列表

    列表在日常的文本展示使用,用于展示信息的相关性,而复选框经常被用于在日常待办事项的列表的编写中,一般我在印象笔记中会选择用复选框标注该待办事项是否完成,值得一提的是印象笔记的电脑客户端已经开始支持Markdown语言了。

    1. 一级有序列表
    	1. 二级有序列表
    	2. 二级有序列表
    2. 一级有序列表
    - 一级无序列表
    	- 二级无序列表
    	- 二级无序列表
    - 一级有序列表
    * [ ] 复选框未选择
    * [x] 复选框已选中
    

    效果如下

    1. 一级有序列表
      1. 二级有序列表
      2. 二级有序列表
    2. 一级有序列表
    • 一级无序列表
      • 二级无序列表
      • 二级无序列表
    • 一级有序列表
    • [ ] 复选框未选择
    • [x] 复选框已选中

    四、字体

    斜体:*斜体字体*
    加粗:**加粗字体**
    高亮:==高亮字体==
    转义字符:	heta
    下划线:<u>Markdown</u>
    删除线:~~微信公众号不能使用Markdown~~
    字体颜色:<font color=#FF0000> 设置字体颜色为红色 </font>   
    

    效果如下

    斜体:斜体字体
    加粗:加粗字体
    高亮:高亮字体
    下划线:Markdown
    删除线:微信公众号不能使用Markdown
    字体颜色: 设置字体颜色为红色

    五、插入数学公式

    公式有行间公式与行内公式的区别,以机器学习中的线性模型为例,做如下展示

    一般的向量模型:
    $$
    f(oldsymbol{x})=oldsymbol{w}^{mathrm{T}} oldsymbol{x}+b
    $$
    其中:$oldsymbol{x}=left(x_{1} ; x_{2} ; ldots ; x_{d}
    ight)$,$
    oldsymbol{w}=left(w_{1} ; w_{2} ; ldots ; w_{d}
    ight)
    $,其中$x_i$是$x$在第$i$个属性上的取值。
    

    效果如下

    一般的向量模型:

    [f(oldsymbol{x})=oldsymbol{w}^{mathrm{T}} oldsymbol{x}+b ]

    其中:(oldsymbol{x}=left(x_{1} ; x_{2} ; ldots ; x_{d} ight)),(oldsymbol{w}=left(w_{1} ; w_{2} ; ldots ; w_{d} ight)),其中(x_i)(x)在第(i)个属性上的取值。

    六、流程图以及时序图

    流程图以及时序图的绘制,我选择的Markdown绘图插件:mermaid

    流程图的mermaid语法如下:

    ​```mermaid
    graph LR;
        A[模块A] -->|A1| B(模块B)
        B --> C{判断条件C}
        C -->|条件C1| D[模块D]
        C -->|条件C2| E[模块E]
        C -->|条件C3| F[模块F]
    ​```
    
    graph LR; A[模块A] -->|A1| B(模块B) B --> C{判断条件C} C -->|条件C1| D[模块D] C -->|条件C2| E[模块E] C -->|条件C3| F[模块F]

    时序图的mermaid语法如下:

    ​```mermaid
    sequenceDiagram
    	opt connect
    	Note over PythonClient,CppSever: 三次握手连接确定双方信息
        PythonClient->>CppSever: SYN,1000(0),<mss 1024>
        CppSever-->>PythonClient: SYN,8000(0),ACK 1001,<mss 1024>
        PythonClient->>CppSever: ACK 8001
    	end
    	loop transfer
    	Note over PythonClient,CppSever: Cpp一直向Python单向传输数据
        PythonClient->>CppSever: 1001(20),ACK 8001
        CppSever-->>PythonClient: 8001(258),ACK 1021
        PythonClient->>CppSever: ACK 8259
    	end
    	opt disconnect
    	Note over PythonClient,CppSever: 四次握手断开,每个方向单独断开
        PythonClient->>CppSever: FIN,1021(0),ACK8001
        CppSever-->>PythonClient: ACK 1022
        CppSever-->>PythonClient: FIN,8001(0),ACK 1022
        PythonClient->>CppSever: ACK 8002
    	end
    ​```
    

    效果如下

    sequenceDiagram participant client participant sever opt connect note over client,sever:三次握手连接确定双方信息 client->>sever:SYN,1000(0),<mss 1460> sever->>client:SYN,5000(0),ACK 1001,<mss 1024> client->>sever:ACK 5001 end

    插入链接

    [Flame's Github](https://github.com/FlameAlpha)
    

    Flame‘s Github

    插入图片

    ![Markdown](https://d33wubrfki0l68.cloudfront.net/f1f475a6fda1c2c4be4cac04033db5c3293032b4/513a4/assets/images/markdown-mark-white.svg)
    

    在这里插入图片描述

    插入代码块

    在Markdown语言中代码段的加入会识别所标注的语言从而实现代码高亮显示。

    ​```c++
    #include <iostream>
    #include <thread>  //①
    void hello()  //②
    {
      std::cout << "Hello Markdown
    ";
    }
    ​```
    

    效果如下,你没看错上面的所有的Markdown源码的展示都是使用这个工具:

    #include <iostream>
    #include <thread>  
    void hello()  
    {
      std::cout << "Hello Markdown
    ";
    }
    

    相关工具推荐:

    Markdown在线编辑工具:dillingerCmd Markdown

    Markdown离线编辑工具:Typora印象笔记MarkdownPad

    Markdown离线PowerPoint工具:Marp

    论文排版利器:LaTeX

    PowerPoint的LaTex加载项工具:IguanaTex

    公式image转LaTex工具:mathpix

    任世事无常,勿忘初心
  • 相关阅读:
    Git总结
    MongoDB基础总结
    Docker总结
    Java总结
    jQuery总结
    Bootstrap4总结
    QQ企业通--客户端登陆模块设计---知识点
    INI文件,WritePrivateProfileString()和GetPrivateProfileString()函数----转载
    C#调用Win32 的API函数--User32.dll ----转载
    C# 中[DllImport("user32.dll")]和extern用法和示例----转载
  • 原文地址:https://www.cnblogs.com/FlameBlog/p/14715339.html
Copyright © 2011-2022 走看看