Markdown入门

Markdown入门,第1张

学习Python技能树,但是不知道为什么是从这个内容开始的,反正多学一门学问也是没有问题的,那就开始吧。

一、如何写好技术文章
  1. 搞清楚主谓宾 让人清晰的理解你所说的内容,有时候使用必要的连词,比如:因为。。。所以。。。/首先。。。其次 等 是个很好的选择

  2. 不滥用代词/过渡词和标点符号 代词过多,不容易让人理解你所指代的内容,尤其是含有多个代词的情况下。 标点符号的正确使用,也是让人更容易理解,使人明确你开始表达另一个含义了。

  3. 多使用强势动词,代替形容词和副词
    强化阅读人员在头脑中的印象。
    例如:跑比走更强势、砍比切更强势
    形容词跟副词增加了理解难道

  4. 正确使用术语
    约定熟成的术语,比如:TCP/IP、SDK等,就比Tcp/ip、sdk更容易让人识别

  5. 正确使用段落
    每段要有独立主题。
    好的开头可以让人一下就判断出本段主题。
    控制段落长度,避免疲劳

  6. 适当使用列表和表格
    清晰的脉络结构

  7. 一图胜千言
    内容更生动,引起人员兴趣
    图中要突出重点,去除其余项目干扰
    图片标题准确
    统一的样式风格

  8. 把握好整体文档结构

  9. 明确文档目标群体

二、MarkDown学习

ok,现在开始学习MarkDown。

2.1、段落及强调

首先介绍段落构成,通常段落包括:链接、强调、代码、图片等。

2.1.1 链接

链接分为行内式和参考式两种:

  1. 行内式:链接直接存在于文本之内,没有相对独立的段落来定义所有的链接。

格式:[链接文字](链接地址 “地址标题(可选)”)

例如:

 [an example](edu.csdn.net"csdn学习“) 

显示如下:
an example

注意:如果链接处于同一服务器,也可使用相对路径>

  1. 参考式链接,将链接统一规整到一个独立区域编辑

格式:
[链接文字] [链接标记] /// 文本内链接:
[链接标记]:-space or tab- 链接地址(Tiltle)(可选)///在任意位置定义链接内容

例如:

[AnExample] [example]
[example]:edu.csdn.net"csdn学习"

显示如下:
[AnExample] [example]
[example]: (csdn学习)

其他说明:

  1. [an example]与[id]之间可以使用空格让结构更美观
    2.地址标题是个很鸡肋的功能,可以使用”“or’'or()标记
    3.链接地址可以用<>包裹
    4.链接标记使用字母、数值、空格、标点符号,但是不区分大小写
    隐式链接标记,可以直接用链接文字代替标记,标记位使用空
2.1.2强调

格式
*Anexample1* ///斜体
_Anexample2_ ///斜体
*Anexample3* ///加粗
__Anexample4__ ///双下划线,加粗

例如代码:

*Anexample1*
_Anexample2_
**Anexample3**
__Anexample4__

显示如下:
Anexample1
Anexample2
Anexample3
Anexample4

2.1.3 代码

格式:
```key(例如python)
This is a code.
```
行内代码块 ’code’

显示如下:

This is a code.

代码‘code’

2.1.4图片

与链接结构相似。

结构:
行内式:
![文字](图片地址”Title“)
参考式
![文字] [id]
[id]: 图片地址

2.1.4 分隔符

— ///至少三个短线
___ ///至少三个下划线
*** ///至少三个*号

效果:

下划线必须在英文输入状态
独立一行内,不能出现其他字符
*号之间可以有空格

2.2 标题 2.2.1 使用#定义标题,分六级
# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题

显示效果:

一级标题 二级标题 三级标题 四级标题 五级标题 六级标题

注意:符号后面有空格

2.2.2 使用=和-标记一二级标题
结构:
这是一级标题 这是二级标题
显示效果:
这是一级标题 这是二级标题 2.2.3 使用HTML标签
这是一级标题
这是一级标题
这是一级标题
这是一级标题
这是一级标题
这是一级标题

显示效果:

这是一级标题 这是一级标题 这是一级标题 这是一级标题 这是一级标题 这是一级标题 2.3 列表 2.3.1 无序列表

结构
-aaa
+aaa
*aaa

显示效果:

  • aaa
  • aaa
  • aaa

注意:符号后面有空格

2.3.2 有序列表

定义:

  1. aaa
  2. bbb
  3. ccc

效果:

  1. aaa
  2. bbb
  3. ccc

点后面有空格

2.3.3 多级嵌套列表

无有效解决方案,使用无极列表创建。

-1. aaa
- 1.1. bbb

2.3.4 创建多选列表
  • todo

效果:

  • do something
  • anything

注意:方括号内含有一个空格

2.4 引用与交叉引用 2.4.1 引用

引用内容

效果:

引用内容

有的编译器需要在>后面加空格
生效关键>位于行首
以一个回车结束更可靠

2.4.2 交叉引用

使用HTML语言进行引用

2.4.2.1 引用图片 2.4.2.2 引用表格 2.4.2.3 引用参考文献

角标:
1990年,推荐系统的概念首次被哥伦比亚大学的Jusii Karlgren教授在一份报告[1](#R1)中提及。

效果:

1990年,推荐系统的概念首次被哥伦比亚大学的Jusii Karlgren教授在一份报告1中提及。

其余不深入。

2.5 表格 2.5.1 创建表格

使用|(竖线)
| Column 1 | Column 2 | Column 3 |
|:--------| :---------:|--------:| ///对齐方式
| centered 文本居左 | right-aligned 文本居中 |right-aligned 文本居右|

效果:

Column 1Column 2Column 3
centered 文本居左right-aligned 文本居中right-aligned 文本居右

Tips
表格中的|使用 | 代替可以正常显示

2.5.2 内容修饰 2.5.2.1 斜体,粗体,换行

内容 ///斜体
内容 /// 粗体

标签换行

2.5.2.2 合并 2.5.2.3 Excel 转HTML

另存为html格式
在浏览器中打开
查看原代码
复制到MarkDown中
这属于作弊 -----😐

欢迎分享,转载请注明来源:内存溢出

原文地址: http://outofmemory.cn/langs/942719.html

(0)
打赏 微信扫一扫 微信扫一扫 支付宝扫一扫 支付宝扫一扫
上一篇 2022-05-18
下一篇 2022-05-18

发表评论

登录后才能评论

评论列表(0条)

保存