原来Github上的README.md文件这么有意思——Markdown语言详解

article/2025/9/23 13:23:11

    转载请注明出处:http://blog.csdn.net/zhaokaiqiang1992

    之前一直在使用github,也在上面分享了不少的项目和Demo,每次创建新项目的时候,使用的都是默认的README.md文件,也不曾对这个文件有过什么了解。但是在看到别人写的项目的README.md里面竟然有图片、链接什么的,就感到很好奇,这效果是什么加上去的?于是便查了一下资料,结果,竟迁出了一门从来没有了解过的语言— —Markdown!

    github上的README.md文件就是使用的Markdown语言编写的,我们先简单介绍下这门语言的来龙去脉,然后再介绍一些基本的语法和使用。


    1.来龙去脉和语法特点

    Markdown 是一种轻量级标记语言,创始人为约翰·格鲁伯(John Gruber)。它允许人们“使用易读易写的纯文本格式编写文档,然后转换成有效的XHTML(或者HTML)文档”。这种语言吸收了很多在电子邮件中已有的纯文本标记的特性。


   Markdown 的目标是实现「易读易写」。可读性,无论如何,都是最重要的。一份使用 Markdown 格式撰写的文件应该可以直接以纯文本发布,并且看起来不会像是由许多标签或是格式指令所构成。Markdown 语法受到一些既有 text-to-HTML 格式的影响,包括Setext、atx、Textile、reStructuredText、Grutatext 和 EtText,而最大灵感来源其实是纯文本电子邮件的格式。总之, Markdown 的语法全由一些符号所组成,这些符号经过精挑细选,其作用一目了然。比如:在文字两旁加上星号,看起来就像*强调*。Markdown 的列表看起来,嗯,就是列表。Markdown 的区块引用看起来就真的像是引用一段文字,就像你曾在电子邮件中见过的那样。


    Markdown 语法的目标是:成为一种适用于网络的书写语言。Markdown 不是想要取代 HTML,甚至也没有要和它相近,它的语法种类很少,只对应 HTML 标记的一小部分。Markdown 的构想不是要使得 HTML 文档更容易书写。在我看来, HTML 已经很容易写了。Markdown 的理念是,能让文档更容易读、写和随意改。HTML 是一种发布的格式,Markdown 是一种书写的格式。就这样,Markdown 的格式语法只涵盖纯文本可以涵盖的范围。


    正是因为Markdown的这些特点,而且功能比纯文本更强,因此有很多人用它写博客。世界上最流行的博客平台WordPress和大型CMS如joomla、drupal都能很好的支持Markdown。


          2.编辑软件

如果我们要写Markdown代码的话,我们首先需要一个编辑器,因为我使用的是Mac,所以推荐使用Mou,非常的强大,非常的好用。
    下面是Mou的界面,左边是Markdown代码,右边是实时的展示效果,而且可以选择不同的主题色,非常的漂亮!



    当然,如果你使用的是其他的平台的话,你可以选择在线的编辑器,效果也非常棒。
    给出两个在线的Markdown编辑器
    http://mahua.jser.me/
    http://maxiang.info/
    第一个是个人开发的,免费使用,非常赞!
    第二个是一个已经发布的产品,可以免费在线编辑。除此之外,还可以将内容同步到印象笔记,不过只能试用10天,之后需要79/年,还是非常不错的。

    3.常用语法介绍

      这里只介绍最常用和最常见的功能,若想查看全部的语法,请移步http://wowubuntu.com/markdown/index.html
(1)标题
    标题使用不同数量的"#"来标识是什么层级,可以对应于HTML里面的H1-H6,下面是示例代码和效果



    “========”风格的也可以,但是我不喜欢,赶不上"#"的好用

   (2)图片
    我们可以使用下面的语法,添加一个图片
    ![Alt text](/path/to/img.jpg)
    详细叙述如下:
    一个惊叹号 !
    接着一个方括号,里面放上图片的替代文字
    接着一个普通括号,里面放上图片的网址

    下面是一个示例



    (3)强调
    我们可以使用下面的方式给我们的文本添加强调的效果

*强调* 或者 _强调_  (示例:斜体)
**加重强调** 或者 __加重强调__ (示例:粗体)
***特别强调*** 或者 ___特别强调___ (示例:粗斜体)

    下面是一个示例:




    (4)代码
    如果我们想在文章中添加代码,我们有两种方式
    第一种方式是使用反引号(esc键下面的按钮)将代码包裹起来
    下面是一个示例代码



    第二种方式则是使用制表符或者至少4个空格进行缩进的行
    下面是一个示例代码




    (5)换行
    如果我们想把一行文本进行换行,我们可以在需要换行的地方输入至少两个空格,然后回车即可,注意,如果不回车,是没有效果的,就像下面这样




   (6)引用
   如果我们在文章中引用了资料,那么我们可以通过一个右尖括号">"来表示这是一段引用内容。我们可以在开头加一个,也可以在每一行的前面都加一个。我们还可以在引用里面嵌套其他的引用,下面是一个示例:




(7)链接
    如果我们文章中加入一个链接,那么我们通过下面的方式添加
[链接文字](链接地址)
例子: [Markdown](http://blog.csdn.net/zhaokaiqiang1992)





    (8)分割线
    如果我们想用分割线对内容进行分割,我们可以在单独一行里输入3个或以上的短横线、星号或者下划线实现。短横线和星号之间可以输入任意空格。以下每一行都产生一条水平分割线。




    (9)列表标记
    如果我们的内容需要进行标记,那么我们可以使用下面的方式




    好了,这些东西完全够用了,休息,休息一下...

http://chatgpt.dhexx.cn/article/lE7jOtAU.shtml

相关文章

如何规范写出 README 模板?

README 标准是由 RichardLitt 发起,十多名开发者共同贡献完成的,在 GitHub 上有 1230 Star:standard-readme 标准 README 实例: standard-readme/tree/main/example-readmes奖励:实例 本文模板获取地址:…

GitHub README-Template.md - README.md 模板

GitHub README-Template.md - README.md 模板 A template to make good README.md. https://gist.github.com/PurpleBooth/109311bb0361f32d87a2 # Project TitleOne Paragraph of project description goes here## Getting StartedThese instructions will get you a copy o…

怎么写一个超棒的 README 文档

点击上方 Java后端,选择 设为星标 优质文章,及时送达 大数据文摘出品 来源:medium 编译:青柠 如果你很着急、只是想要模板,可以直接跳到底部(但这样一点不酷),准备酷的人&#xff0c…

【工具推荐】最简单方法创建 README

CSDN话题挑战赛第1期 活动详情地址:https://marketing.csdn.net/p/bb5081d88a77db8d6ef45bb7b6ef3d7f 参赛话题:程序员常用小工具推荐 话题描述:俗话说,工欲善其事,必先利其器。作为每天和各种开发工具打交道的程序…

编写规范的readme文件

为什么要写这篇博客? 其实我是一个入坑已经半年的程序员,因为不是计算机专业,只能自己摸索,所以我深知博客的重要性。每次我的学习笔记啊,项目的,面试题啊,有的,只要有时间&#xff…

如何写好github上的README

项目名称(超大字体或者是图片形式) 这里再写一句骚气又精准的话描述你的项目吧 上手指南 写几句这样的话概括接下来的内容:以下指南将帮助你在本地机器上安装和运行该项目,进行开发和测试。关于如何将该项目部署到在线环境&…

README.md编写

一、摘要 项目一般会有个描述文件,对于项目的代码来讲,这个描述就是README.md文件,可以描述各模块功能、目录结构等。该文件可以方便让人快速了解项目的代码结构和功能。当然,若要深层次的了解项目,就得看项目总体的需…

GitHub上README.md编写教程(基本语法)

主要参考:GitHub上README.md编写教程(基本语法)_无名的一棵小树-CSDN博客_readme.md语法 一、标题写法: 第一种方法:标题文本下方加“”号或“--”号 1、在文本下面加上等于号“” ,那么上方的文本就变成…

README.md文件

引言: README.md文件用的是Markdown编写的,所有我们先来看看Markdown的语法 首先在github上面某个项目里面创建一个README.md,然后在里面区编辑内容,如图, 点击edit file在下面输入内容,然后切换到preview changes进…

GitHub上README.md教程

最近对它的README.md文件颇为感兴趣。便写下这贴,帮助更多的还不会编写README文件的同学们。 README文件后缀名为md。md是markdown的缩写,markdown是一种编辑博客的语言。用惯了可视化的博客编辑器(比如CSDN博客,囧)&a…

README文档的规范写法

看过很多开源库,发现有些库的文档写的一团糟,有的甚至就是一个标题,让你自己下载之后运行,自己摸索,看的很头疼。而那些使用量大的库的文档写的很标准,很详细,看的很舒服。 README文档写的好的…

你真的知道README吗?

目录 README MarkDown README的要素 API文档 总结 README是我们开发项目必备的文件,之前没有认真的研究过,都是大概的了解下,没想到里面也是一门大学问,话不多说,直接码起来。 README README是项目自我描述文件…

软件项目规范(1):README文件的基本写作规范

看Github的开源项目,我们都能看到README.md文件的身影。 有不少同学都喜欢将自己的项目上传到Git托管起来,但是总能发现一个问题:明明自己这个项目挺有市场的啊,怎么这个代码放上去,就显得很“非官方”! …

Java基础-快速入门

Java基础 Java基础-快速入门java简介java介绍java版本为什么学习javajava特点java优缺点优点缺点 java应用范围适用于不适用于 java规范java平台 安装JDK第一个Java程序安装并使用EclipseEclipse介绍Eclipse安装使用Eclipse创建第一个项目 安装Eclipse插件 Java基础-快速入门 …

Java-基础入门

1.发展历史 1995年Sun公司发布Java1.0版本 1997年发布Java1.1版本 1998年发布Java1.2版本 2000年发布Java1.3版本 2002年发布Java1.4版本 2004年发布Java1.5版本 2006年发布Java1.6版本 2009年Oracle甲骨文公司收购Sun公司,并于2011发布Java1.7版本 2014年…

java入门笔记

1. Java相关概念 编程:用倾向于自然语言的方式编写指令代码的过程 编译:将自然语言指令代码转化为机器语言(二进制)的过程系统差异化:为了用不同类型的芯片实现相同的功能,就需要用不同的指令代码操作不同…

一、Java基础入门

一、java简介 1.1 前言 Java语言是美国Sun公司(stanford University Network),在1995年推出的高级编程语言。所谓编程语言是计算机的语言,人们可以使用编程语言对计算机下达命令,让计算机完成人们需要的功能。 1996年1月,Sun公司发布了Java的…

Java基础及入门

一、软件开发基础 1.什么是JavaEE JavaEE是一门接收来自客户端的请求,并通过响应返回给客户端数据的技术。 2.JavaEE理解图 2.常用的开发语言 二、Java开发环境搭建 1.什么是JDK及JRE 安装JRE的目的是什么?(是为了编译代码) JDK&…

java入门的基础(入门必读)

Java入门基础 什么是java程序开发Java的运行环境开发Java程序的步骤java的基本框架数据类型、变量数据类型变量变量名命名规则 运算符关系运算符逻辑运算符算术运算符 扫描仪的使用if选择结构多重if选择结构嵌套if选择结构 switch选择结构循环结构while循环结构do-while循环结构…

JAVA基础学习入门

JAVA入门之基本语法(一) 最近开始复习JAVA语言为找工作做准备,方便以后再次复习或者用到的时候回顾。先是从JAVA的基本语法学起,因为有c和c语言的基础知识铺垫,所以这部分的笔记会比较粗略,毕竟语言都是贯…