学习笔记:利用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.
会显示为…
学习笔记:利用markdown写readme文档 (Udacity学城)_第1张图片

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. 有序列表1
  2. 有序列表2
  3. 有序列表3

链接和图片

[link text](http://example.com/ “optional title”)
会显示为:
link text

![这里写图片描述](http://img3.douban.com/mpic/s1108264.jpg)
会显示为:
!这里写图片描述

代码块引用

在代码开头和结尾加上三个反斜号“`

if p.visualization_dbg==1
    mySubplot(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学城)_第2张图片

学习笔记:利用markdown写readme文档 (Udacity学城)_第3张图片

你可能感兴趣的:(工具使用,markdown)