自媒体 | 使用Markdown高效率编写文档

简介: 自媒体 | 使用Markdown高效率编写文档

image.png

前言


  • HTML(HyperText Markup Language)是重量级的标记语言,造就了主次分明、层次清晰的网页
  • Markdown是一种轻量级的标记语言(Lightweight Markup Language),满足了主要的文本格式标记的需求,操作性大大简化,易写易读


兼容性


市面上存在太多的Markdown编辑器,遵循以下经验有助于实现更好的兼容性:

  • 缩进
    应该使用显式的缩紧语法,而不应该使用Tab键

不兼容用法:Tab段落

正确用法:  段落

  • 完整而精简
    确保没有多用或者少用标记符号

不兼容用法:-- 列表、```代码

正确用法:- 列表、```代码```

  • 空格
    不应该忽略分割标记符与文本的空格

不兼容用法:#一级标题

正确用法:# 一级标题

  • 转义符
    确保所有需要转义的符号都带了转义符
  • 检查
    事实上,很难确保同一篇md文档在所有编辑器上保证一致的显示。在遵循以上经验的前提下,移植文档之后还需要认真检查


1、标题

  • 1.1、六级标题
  • 举例:
# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题
复制代码
  • 效果:


一级标题

二级标题

三级标题

四级标题

五级标题
六级标题
  • 1.2、高级标题与次级标题
  • 举例:
高级标题
=
次级标题
-
复制代码
  • 效果:


高级标题

次级标题(次级标题稍微小一些)


2、文本效果

  • 斜体
  • 举例:*斜体*、_斜体_
  • 效果:斜体斜体
  • 加粗
  • 举例:**加粗文字**、__加粗文字__
  • 效果:加粗文字加粗文字
  • 删除
  • 举例:~~删除内容~~
  • 效果:删除内容


3、引用


段落前添加一个**>来标记为引用,重复使用>>可以创建更多级别的引用,使用一个空行**来结束该级别。


  • 举例:


>something
>>something
>something(X 降级需要先使用一个空行结束上一级的引用)
something
复制代码
  • 效果:


something

something something

something


4、分割线


使用三个或以上的***-** 或**_来来创建分割线,符号后不能接其他内容。(注意:使用__---__时,在之前空一行**,可以避免被当作标题标记)。

  • 举例:


***
---
___
复制代码
  • 效果:


5、链接


  • 文内链接
  • 举例:
something[链接说明](http://www.baidu.com "optional hint")something
注意:网址和提示字符串之间需要空格
复制代码


  • 引用链接和文内链接类似,但是它把链接的内容放在其他位置,可以使可以被识别的任意位置。
  • 举例:


This is [链接说明] [id] 
[id]: http://www.baidu.com/ "Optional Title Here"
注意:网址和提示字符串之间需要空格
复制代码
  • 效果:
    This is [链接说明] id reference-style link
  • 超链接或邮箱


  • 举例:
something<http:www.baidu.com>something
something<809072649@qq.com>something
复制代码


6、插入图片


插入图片和插入链接非常类似,只是在方括号前多一个**!**。

  • 举例:


[图片上传失败...(image-8361f6-1564327831975)] 
注意:路径和提示字符串之间需要空格
复制代码
  • 效果:


image.png

7、列表


  • 举例:
|左对齐|中间对齐|右对齐|
|:---|:---:|---:|
|左1|中1|右1|
|左2|中2|右3|
复制代码
  • 效果:


左对齐 中间对齐 右对齐
左1 中1 右1
左2 中2 右3



8、引用参考


参考内容会被放到文末,点击即可实现跳转(注意:^后的文本是任意的,会被解析成有序的数字,在参考内容后接空行来标记参考内容结束)。

  • 举例:


使用 Markdown[^3]可以效率的书写文档, 直接转换成 HTML[^2], 你可以使用 Leanote[^Le] 编辑器进行书写。
[^3]:Markdown是一种纯文本标记语言
[^2]:HyperText Markup Language 超文本标记语言
[^Le]:开源笔记平台,支持Markdown和笔记直接发为博文
复制代码
  • 效果:
    使用 Markdown1可以效率的书写文档, 直接转换成 HTML2, 你可以使用 Leanote3 编辑器进行书写。


9、上下角标

  • 举例:
O<sup>2</sup>
O<sub>2</sub>
复制代码
  • 效果:
    O2
    O2


10、换行


**<br>或者<br/>**用来标记换行


11、转义


使用**\**进行转义


12、代码


使用两个**```**将代码包围起来


13、命名描记(页内超链接)


跳转到的地方点击跳转


14、缩进


空格 半格 一格
&nbsp; &ensp; &emsp;
  • 举例:


文本&nbsp;文本&ensp;文本&emsp;文本
复制代码
  • 效果: 文本 文本 文本 文本
目录
相关文章
|
7月前
|
JSON 前端开发 JavaScript
Docusaurus框架——快速搭建markdown文档站点介绍sora
Docusaurus框架——快速搭建markdown文档站点介绍sora
199 0
|
7月前
|
前端开发
914.【前端】Taro集成towxml渲染markdown文档
914.【前端】Taro集成towxml渲染markdown文档
436 2
|
2月前
|
IDE Java 开发工具
在 Vim 里为 Markdown 文档展示导航窗格
在一个很长的 Markdown 文档里要准确跳转到某标题并不容易,如果像 Word 那样有个导航窗格就好了。
36 6
|
3月前
基于typora编写Markdown文档
如何使用Typora编写Markdown文档的教程,包括软件设置、快捷键使用以及一些使用技巧。
82 18
|
5月前
|
JavaScript Java
Java 将Markdown文件转换为Word和PDF文档
【7月更文挑战第5天】Java中使用`Spire.Doc for Java`库可方便地将Markdown转换为Word或PDF。基本步骤包括导入模块,创建`Document`对象,加载Markdown文件,然后保存为目标格式(`.docx`或`.pdf`)。若遇到`Invalid UTF-8 stream`错误,需确保Markdown文件是UTF-8无BOM编码。页面设置可通过`PageSetup`类调整。注意,实际应用会依据具体需求和环境有所调整。
324 6
|
5月前
|
JSON 监控 数据挖掘
上网行为管理软件中的Markdown文档编写与格式化
Markdown是轻量级标记语言,用于快速排版和格式化文本,常见于技术文档和博客。基本语法包括:#(1-6个)创建标题,空行分隔段落,*或-创建列表,[文本](链接)插入链接,![文本](图片URL)插入图片。此外,还有代码块(```包围)、引用(&gt;)等高级格式。Markdown支持HTML嵌入以自定义样式,并广泛应用于上网行为管理等领域的文档编写。通过自动化脚本,能将监控数据提交至网站进行分析。
52 6
|
5月前
|
自然语言处理 开发者 Python
Markdown 是一种轻量级标记语言,它允许人们使用易读易写的纯文本格式编写文档,然后转换成格式丰富的 HTML 内容。Markdown 的语法简洁明了、学习容易,而且功能比纯文本更强。
Markdown 是一种轻量级标记语言,它允许人们使用易读易写的纯文本格式编写文档,然后转换成格式丰富的 HTML 内容。Markdown 的语法简洁明了、学习容易,而且功能比纯文本更强。
|
5月前
|
Unix Linux Shell
Sphinx是一个Python文档生成工具,它可以解析reStructuredText或Markdown格式的源代码注释,并生成多种输出格式,如HTML、LaTeX、PDF、ePub等。
Sphinx是一个Python文档生成工具,它可以解析reStructuredText或Markdown格式的源代码注释,并生成多种输出格式,如HTML、LaTeX、PDF、ePub等。
|
5月前
|
存储 JavaScript Python
word文档转成Markdown文档并在Typora免费版添加图床-----想想都很香
word文档转成Markdown文档并在Typora免费版添加图床-----想想都很香
197 0
|
7月前
|
存储 对象存储 C++
在 VS Code 中使用 OSS 进行 Markdown 文档编写
阿里云OSS对象存储服务是理想的存储解决方案,专门用于承载大量非结构化数据。在VSCode中编写Markdown文档时,手动上传图片至OSS并获取相应链接的过程通常复杂且耗时。为此,Aliyun OSS Uploader插件应运而生,以简化和优化此流程。它不仅能够自动将图片上传到OSS并生成可供插入的链接,还能在您需要时通过撤回链接,删除已上传的图片,极大地提升了效率和便捷性。
下一篇
DataWorks