• Python(04):markdown基本语法


    一、前言

    Markdown是一种可以使用普通文本编辑器编写的标记语言,通过简单的标记语法,它可以使普通文本内容具有一定的格式。    --摘自百度百科

    没想到一向不太靠谱的百度百科这次竟有了如此精辟的解释。之前项目一直使用word撰写文档,有比较大的弊病:

    • 只能对纯文本文件进行版本控制,而word是二进制格式
    • 格式繁杂,经常需要中断写作来控制格式
    • 代码与文档分离,给写文档造成更大的阻力

    而假如单纯的使用txt,就没有一点格式了,用html虽然既有格式又能加入版本控制,但是需要花费较多的时间在标签上,而且标签占了文档的较大百分比,不易阅读。

    所以,最终的解决方案就是 **Markdown** ,作为一种轻量级的标记语言,能在非常短的时间内掌握。而且不仅可以用于写文档,还可以写博客、写简书、做一些随手笔记。Markdown文件以.md结尾,可以导出为html和PDF(需要使用的工具支持)。它是一种语法(个人认为是简化版的html),但是和html不同的是,各种解析器对其会有不同的表现。比如我的IDEA Markdown插件会把分割线显示成一条细灰线,Cmd Markdown则是显示一条虚线。所以建议保持使用一种Markdown工具和尽量使用标准语法。

    二、Markdown基本语法

    1、 标题

    如果一段文字被定义为标题,只要在这段文字前加 # 号即可。总共六级标题,建议在井号后加一个空格,这是最标准的 Markdown 语法。

    代码:

    # 一级标题
    ## 二级标题
    ### 三级标题
    #### 四级标题
    ##### 五级标题
    ###### 最小只有六级标题

    效果:

    过于粗暴,不予以展示,你复制粘贴即知晓!!!

    2、换行符

    在markdown中,回车表示换行,空行表示一个新段落。

    dfasdfasdfs  adfsa   aa   adf 
    新行
    新行

    新段落

    效果

    dfasdfasdfs adfsa aa adf
    新行
    新行

    新段落

    3、 粗体

    用两个 * 包含一段文本就是粗体的语法,用一个 * 包含一段文本就是斜体的语法。

    代码:

    **我被加粗了**

    效果:

    我被加粗了

    4、斜体

    *单个星号* 或者 _单下划线_表示斜体

    代码:

    *我倾斜了*

    效果:

    我倾斜了

    5、删除线

    ~~删除线~~

    效果如下:

    删除线

    6、 列表

    列表的显示只需要在文字前加上 - 或 * 即可变为无序列表,有序列表则直接在文字前加1. 2. 3. 符号要和文字之间加上一个字符的空格。

    1、有序列表

    代码:

    1. one
    2. two 
    3. three

    效果:

    1. one
    2. two
    3. three

    2、 无序列表

    *符号可以替换为+或-。

    代码:

    * one
    * two
    * three

    效果:

    • one
    • two
    • three

    7、 引用

    如果你需要引用一小段别处的句子,那么就要用引用的格式。(> + 空格 + 引用文字)

    代码:

    > hello markdown!

    效果:

    hello markdown!

    代码:

    > hello markdown!
    >> hello markdown!

    效果:

    hello markdown!

    hello markdown!

    8、 特殊显示(`式)

    标记代码使用反引号,即在英文输入法下,ESC键下面和1键左边的符号——`

    只需要用两个 ` 把中间的代码包裹起来。

    代码:

    `print('hello nick')`

    效果:

    print('hello nick')

    9、 代码区域(```式)

    在'''和'''之间添加对应的代码。

    代码:

    ```python
    print('hello nick')
    ```

    效果:

    print('hello nick')

    10、链接

    用<括号括起来>, 把URL作为链接插入。

    代码:

    <https://www.baidu.com>

    效果:

    https://www.baidu.com

    11、链接(链接描述显示)

    [链接描述](链接地址)

    代码:

    [百度](https://www.baidu.com "alt描述信息")

    效果:

    百度

    12、图片

    插入链接与插入图片的语法很像,区别在一个 !号。

    ![图片描述(选填)](图片地址)

    代码:

    ![baidu.jpg](https://www.baidu.com/img/baidu_jgylogo3.gif 'alt描述信息')

    效果:

    baidu.jpg

    13、图片链接

    [![图片描述(选填)](图片地址)](链接地址)

    代码:

    [![百度logo](https://www.baidu.com/img/baidu_jgylogo3.gif '描述信息')](http://www.baidu.com)

    效果:

    百度logo

    14、分割线

    输入***--- 再按回车即可绘制一条水平线,如下:

    代码:

    ---

    效果:


    15、表格

    而且第二行必须得有,并且第二行的冒号代表对齐格式,分别为居中;右对齐;左对齐)

    name | age | sex 
    :-:|:-|-:
    tony|20|男
    lucy|18|女

    效果:

    nameagesex
    tony 20
    lucy 18

     

    16、表情符号:smile:

    :smile :​(注意为:是英文的冒号)

    :smile:

    17、特殊符号

    用来转义,表示文本中的markdown符号

    三、总结

    以上所述就是Markdown的基本标签,虽然不多,但是可以解决大部分情况。

    可以用20%的标签完成80%的效果

    基础markdown语法参考:https://www.appinn.com/markdown/

    插入数学公式markdown语法参考:https://www.zybuluo.com/codeep/note/163962

  • 相关阅读:
    【C++】《C++ Primer 》第二章
    【剑指Offer】链表的基本操作之创建、插入、删除
    【LeetCode】365.水壶问题
    【Flutter】事件处理与通知之原始指针事件处理
    【Flutter】功能型组件之对话框详解
    【Flutter】功能型组件之异步UI更新
    mongdb_基本操作
    startswith在项目中的应用
    subString在项目中的应用
    comtains在项目中的应用
  • 原文地址:https://www.cnblogs.com/springsnow/p/12033215.html
Copyright © 2020-2023  润新知