学习书写markdown文档

markdown 是什么?

同样是标记语言,但它相比HTML更加简单!一是体现在标记符的数量上,二是体现在标记符的书写上。HTML标记符号非常多,并且需要标记内容的开始和结束位置,而markdown只有四个基本的标记符号,只要在开始位置标记即可。

markdown 解决什么问题?

当我们需要让文档看起来层次分明,但又不依赖于word这样的编辑工具来书写、排版和读取时,markdown的易写易读优势就非常突出了。并且在我使用一段时间以后,发现使用markdown非常有助于帮助作者在写作时整理自己的逻辑思路和段落层次。

怎样书写和读取 markdown?

同HTML一样,你可以使用任何一款纯文本编辑工具来编辑和读取包含markdown格式的文本,但只有在一些特别的工具(如有道云笔记)或网站(如简书)下,才能呈现出渲染后的格式。同时markdown也可以使用HTML来添加格式和排版,这意味着,你即可以使用标准的markdown语法,也可以在其中嵌入HTML标记,但也只能对应其中的一小部分。

markdown 的语法

真的非常简单!

基本符号* - + >

基本上所有的markdown标记都是基于这四个符号及其组合,需要注意的是,如果以基本符号开头的标记,注意基本符号后分割内容的空格

  • 标题

    • 一级标题 # 一级标题

    • 二级标题 ## 二级标题

    • 三级标题 ### 三级标题

    • 四级标题 #### 四级标题

    • 五级标题 ##### 五级标题
    • 六级标题 ###### 六级标题
  • 引用

引用的方式:> 引用内容

  • 段落

    • 段落以自然 回车 作为标记。
  • 分隔符

    • 连续输入三个以上的---添加横线分隔符,如下:

  • 列表

    • 使用* - +中的任何一个符号加空格就可以创建无序列表,但如我这样的完美主义者可以进一步使用+ -来表现层次关系。
    • 使用数字+点+空格创建有序列表
    • 列表可以嵌套,使用时在嵌套列表前空格,这篇文章的列表使用了嵌套列表。
* 这是一个无序列表
* 这是一个无序列表
+ 这是一个父无序列表
  - 这是一个子无序列表
1. 这是一个有序列表`
2. 这是一个有序列表`
[用markdown写下你的第一个md文档](http://www.jianshu.com/p/de9c98bba332)
  • 也可以直接用尖括号包含网址的方式<http://www.jianshu.com>来构成链接 http://www.jianshu.com
  • 图片

    • 像构造一个链接一样,只需要在前面加!
![图片名称](图片地址)

简书

  • 也可以使用html方式来指定图片大小
<img src="//upload-images.jianshu.io/upload_images/95646-5bfd0cecf587c766.png" width="300px" height="240px" alt="简书">

<img src="//upload-images.jianshu.io/upload_images/95646-5bfd0cecf587c766.png" width="300px" height="240px" alt="简书">

  • 代码段

使用

```

代码

```

这样的方式来构建

` 符号在左上角esc键下方,请在半角状态输入

print("这是一个代码段");
  • 字体样式

    • 倾斜 *倾斜*
    • 加粗 **加粗**
    • 倾斜并加粗 ***倾斜并加粗***
  • 表格

    • 使用- |符号把内容分割为你认为合适的表格样式就好。
    • 使用:符号标识对齐。
表头1|表头2|表头3
:----|:-----:|-----:
左对齐|居中对齐|右对齐
表头1 表头2 表头3
左对齐 居中对齐 右对齐
  • 保存

    • 最后将markdown编写的文档存为 .md 格式,就可以用对应的工具查看效果和编辑了。

转载:https://www.jianshu.com/p/de9c98bba332

原文地址:https://www.cnblogs.com/yxrs/p/8657622.html

时间: 2024-08-29 14:12:45

学习书写markdown文档的相关文章

使用shell脚本生成数据库markdown文档

学习shell脚本编程的一次实践,通过shell脚本生成数据库的markdown文档,代码如下: HOST=xxxxxx PORT=xxxx USER="xxxxx" PASSWORD="xxxxxx" DATABASE_PREFIX="xxxxxx" QUERY_DATABASE="select distinct TABLE_SCHEMA from information_schema.TABLES where TABLE_TYPE=

Markdown 文档生成工具

之前用了很多Markdown 文档生成工具,发现有几个挺好用的,现在整理出来,方便大家快速学习. loppo: 非常简单的静态站点生成器 idoc:简单的文档生成工具 gitbook:大名鼎鼎的文档协作工具 docsify:一个神奇的文档站点生成器,简单轻巧,无需静态构建html 教程版: http://me.52fhy.com/learn-markdown-generate-tool/#/ loppo 官网: https://github.com/ruanyf/loppo 依赖 node.js

坚果云Markdown - 文档管理编辑器

坚果云Markdown - 文档管理编辑器 Markdown是什么? Markdown是一种上手简单.应用十分广泛的轻量级标记语法.您可以使用Markdown轻松记录您的灵感.想法.创意.整个记录过程,不需要多分心排版设计,大大提高您的效率. [界面简洁,无内置广告] 坚果云Markdown编辑器界面简洁,无内置广告,为您创建一个不受打扰的写作环境. [多平台同步使用] 坚果云Markdown编辑器支持iOS.Android.Web等多个平台.您可以随时随地创建或编辑纯文本,插入图片.链接.表格

HTML5学习之跨文档传输消息(七)

新标准中提供了文档之间直接的消息传输API.而且不限制跨域消息传递! 发送消息使用的是Window对象的postMessage(data,targetURL)方法就可以了,但给哪个window对象发送消息,就使用哪个window的实例来调用,注意这个细节. 文档默认监听一下message事件就可以接受消息了:window.addEventListener("message", function (ev) {}); 监听消息事件:ev两个重要属性:ev.source指向发送消息的源win

将图片嵌入到markdown文档中

转自KFXW的专栏 将图片嵌入Markdown文档中一直是一个比较麻烦的事情.通常的做法是将图片存入本地某个路径或者网络存储空间,使用URL链接的形式插入图片: ![image][url_to_image] 这样做一个明显的麻烦之处在于处理图片与Markdown文档的一致性上.如果我们要拷贝文档,或者图片遭到误删/云端链接失效,就会变得不便.最让我们省心的方法便是将图片直接放到文档内部. 一个将图片嵌入文档中的方法是使用base64编码.步骤比较简单: 1. 将图片或截图保存在本地: 2. 使用

01将图片嵌入到Markdown文档中

将图片内嵌入Markdown文档中 将图片嵌入Markdown文档中一直是一个比较麻烦的事情.通常的做法是将图片存入本地某个路径或者网络存储空间,使用URL链接的形式插入图片: ![image][url_to_image] 这样做一个明显的麻烦之处在于处理图片与Markdown文档的一致性上.如果我们要拷贝文档,或者图片遭到误删/云端链接失效,就会变得不便.最让我们省心的方法便是将图片直接放到文档内部. 一个将图片嵌入文档中的方法是使用base64编码.步骤比较简单: 将图片或截图保存在本地:

使用vs code编写Markdown文档以及markdown语法详解

目录 首先安装vscode工具,下载地址如下: https://code.visualstudio.com/ 在vs code的扩展中安装: Markdown Preview Enhanced 这款插件,安装完成重新加载即可生效 新建一个.md文件 Visual Studio Code 原生就支持高亮Markdown的语法,想要一边编辑一遍预览,有两种方法: 3.1. Ctrl + Shift + P 调出主命令框,输入 Markdown,应该会匹配到几项 Markdown相关命令 2.2. 先

如何在Markdown文档中插入空格?

简单说 在 Markdown 文档中,可以直接采用 HTML 标记插入空格(blank space),而且无需任何其他前缀或分隔符.具体如下所示: 插入一个空格 (non-breaking space)      或          或        插入两个空格 (en space)       或        或        插入四个空格 (em space)      或        或        插入细空格 (thin space)     或        或       

在MarkDown文档中添加jQuery折叠面板

折腾Hexo博客,做了个软件整理收集页,在首席前端顾问蔡老板的指点下,终于实现了文章中使用折叠面板的功能,现记录如下. 因为想整站都有这样的效果,所以直接集成到使用的主题中,本站使用的是maupassant主题,其他主题应该大同小异,仅供参考. 改造主题 新建定义class或id的js,如我新建了个accordion.js,里面的内容如下 123 $(function() { $( ".accordion" ).accordion();}); 如果用<div id=accordi