学习笔记：利用markdown写readme文档 （Udacity学城）
周末逛知乎等资讯平台的时候，无意间了解到Udacity学城有一期关于利用markdown撰写readme文档的教程，想到CSDN博客也提供了markdown编辑功能，而自己到现在还不会用，看着自己写的丑陋的博客，决定趁此机会学习一下。于是乎，在学习过程中写了以下总结。
以后可以用markdown写博客了，开心~
- Markdown 基础知识
- 设置文本加粗
- 设置文本斜体
- 码还是 不码
- 标题顺序
- HTML 仍然有效
- 使用 md 文件
- 列表
- 无序列表
- 无序列表
- 链接和图片
- 代码块引用
- 实例
Markdown 基础知识
Markdown 是一种轻型标记语言，经常用于 README 的编写（但是也有用其他语言写的！）。它非常简单，大部分语法都很直观。
但实际上，Markdown 有许多不同的“方言”，就像在口语中一样。其中每种“方言”都被称为 Markdown 的“风格（flavor）”。这些方言大致相同，只有细微差别。
课程中讲述的是 GitHub 风格的 Markdown 。
速成教程如下。
设置文本加粗
要将文本设置为粗体，请用两个星号将其括起。因此，这行代码：
Isn’t today a **wonderful** day?
会显示为：Isn’t today a wonderful day?
这比 HTML 中的 标记更易读，还能少打好多字符。
设置文本斜体
要将文本设置为斜体，请在文本两旁添加下划线。因此，这行代码：
And in that moment I thought to myself: _Did I turn off the stove?_
会显示为：And in that moment I thought to myself: Did I turn off the stove?
与上一个示例相似，这样的代码更接近自然语言，原始文档浏览起来非常方便。
码，还是 不码?
内联代码标记，用于标注普通文本中的代码，为此，你需要在代码文本两旁添加反撇号（`，不是单引号）。因此，这行代码：
You should use the `strong` tag.
会显示为：You should use the strongtag.
这比“You should use the strong tag.”有意义多了。
标题顺序
标题更简单！对于 h1 到 h6 标签，你只需要在文本前添加 #。Markdown 会根据 # 的数量生成相应的标题（）标记。例如：
##This is an h2.
###This is an h3.
会显示为…
HTML 仍然有效
使用 Markdown 时要谨记一点，HTML 在 Markdown 中仍然有效。如果有 Markdown 无法完成的工作，完全可以再用回 HTML。
这里的问题是，你的工作很可能会变得过于复杂。如果你需要回到纯 HTML，那么很可能有更简单的格式，就能传达任何你想要说的内容。
使用 .md 文件
与 HTML 文件应使用 .html 扩展名来保存类似，Markdown 文件应该使用 .md 扩展名来保存。
Markdown 本身无法像 HTML 文档一样在浏览器中打开。如果你要预览 Markdown 文件， Dillinger是执行此操作的绝佳在线资源。
列表
无序列表
在符号“-”后加空格使用。
- 无序列表1
- 无序列表2
- 无序列表3
会显示为：
- 无序列表1
- 无序列表2
- 无序列表3
无序列表
有序列表的使用，在数字及符号“.”后加空格几个，如下：
1. 有序列表1
2. 有序列表2
3. 有序列表3
会显示为：
- 有序列表1
- 有序列表2
- 有序列表3
链接和图片
[link text](http://example.com/ “optional title”)
会显示为：
link text
会显示为：
!这里写图片描述
代码块引用
在代码开头和结尾加上三个反斜号“`
if p.visualization_dbg==1mySubplot(2,1,5,1,im_patch_cf,'FG+BG','gray');mySubplot(2,1,5,2,likelihood_map,'obj.likelihood','parula');mySubplot(2,1,5,3,response_cf,'CF response','parula');mySubplot(2,1,5,4,response_pwp,'center likelihood','parula');mySubplot(2,1,5,5,response,'merged response','parula');drawnow
end实例
下面，是一个将html改成markdown标记的例子。
学习笔记：利用markdown写readme文档 （Udacity学城）相关推荐
- 韩顺平php可爱屋源码_韩顺平_php从入门到精通_视频教程_第20讲_仿sohu主页面布局_可爱屋首页面_学习笔记_源代码图解_PPT文档整理...
韩顺平_php从入门到精通_视频教程_第20讲_仿sohu首页面布局_可爱屋首页面_学习笔记_源代码图解_PPT文档整理 对sohu页面的分析 注释很重要 经验:写一点,测试一点,这是一个很好的方法. ...
- Markdown写接口文档，自动添加TOC
上回说到,用Impress.js代替PPT来做项目展示.这回换Markdown来做接口文档好了.(不敢说代替Word,只能说个人感觉更为方便)当然,还要辅之以Git,来方便版本管理. Markdown ...
- Android学习笔记（八）XML文档的解析
一.废话 最近几天四川一直下雨,冷!今天到成都的时候,下午3点多的天和晚上天差不多,黑呼呼的... ...难道传说的2012来了?哈哈哈... ... 二.正文 在上一篇笔记中提到过说在Android ...
- DirectX10 学习笔记2：在多文档框架中初始化DirectX 10
显示功能是在视图类中完成的,所以DX10的初始化及绘制工作都是视图类中完成. 首先建立一个多文档工程,工程名为02_01,在视图类头文件中加载相关的库,并包含头文件: 在视图类的头文件中添加DX10相 ...
- C#学习笔记——MDI窗体（多文档界面）
1.设置父窗体: 如果要将某个窗体设置为父窗体,只需将该窗体的IsMdiContainer属性设置为True即可. 2.设置子窗体: 通过设为某个窗体的MdiParent属性来确定该窗体是那个窗体的子 ...
- C#开发学习笔记:C#实现打印Excel文档
//准备读取生成的Excel文档 Microsoft.Office.Interop.Excel.Application excel = new Microsoft.Office.Interop.Exc ...
- spring-狂神学习笔记-联系我获取md文档
1.Spring(概述) 1.1.简介 Spring:春---->给软件行业带来了春天 2002,首次推出了Spring框架的雏形: interface21框架 Spring框架即以interf ...
- 曲线救国: 使用 Markdown 编辑器来写 Confluence 文档
使用 Markdown 写 Confluence 文档 作为一种轻量级标记语言,Markdown 优点多,包括但不限于: 纯文本,兼容性极强,可以用所有文本编辑器打开 让写作者专注于文字而不是排版 格 ...
- 如何写一个优秀的GitHub项目README文档？
今天给大家介绍一个Github上的README文档写作教程模版,该模版目前获得6634颗星星,2296Fork,相对而言,还是比较得到大家认可的.不花哨,不别出心裁,一个比较实用的,普适性的架子:所谓 ...
最新文章
- 获取this_小程序获取微信运动步数并集成echarts报表显示
- 粒子滤波 应用_如何使用NativeScript开发粒子物联网应用
- 周末不用过来了，好好休息吧_如何好好休息
- 复旦大学高等数学期末试题合集
- 7.OD-字符串参考
- Linux nginx 会话保持（session）
- oracle查被锁存储过程,oracle 结束被锁的包或存储过程
- MAC OS 10.12 安装任意来源应用
- dbutil 1.1.6
- 傅里叶变换【1】：傅里叶变换及逆变换
- cv.threshold()
- android抽屉效果
- Freebase Data Dump 结构初探（二）——浅析元信息
- 第三章 原位正三和弦的连接
- python bif_小猪的Python学习之旅 —— 1.基础知识储备
- 微信小程序开发常见问题总结
- 打通WordPress和微信公众号
- 《众妙之门——自由网站设计师成功之道》一1.8 自由职业者的财务管理
- 哪款蓝牙耳机品质好？音质好的四款蓝牙耳机测评
- /usr/bin/ld:找不到 -lxxx