GVKun编程网logo

GitHub 项目中的 README 和 README.md 有什么区别?(github main和master)

27

如果您想了解GitHub项目中的README和README.md有什么区别?的相关知识,那么本文是一篇不可错过的文章,我们将对githubmain和master进行全面详尽的解释,并且为您提供关于Cm

如果您想了解GitHub 项目中的 README 和 README.md 有什么区别?的相关知识,那么本文是一篇不可错过的文章,我们将对github main和master进行全面详尽的解释,并且为您提供关于Cmd Markdown 在线编辑Github的README.md文档好帮手、flash – 如何将视频嵌入GitHub README.md?、git commit -m ''Add Readme'' 报 error: pathspec ''Readme'''' did not match any file(s) known to git、GitHub ReadME.md的有价值的信息。

本文目录一览:

GitHub 项目中的 README 和 README.md 有什么区别?(github main和master)

GitHub 项目中的 README 和 README.md 有什么区别?(github main和master)

我注意到一些 GitHub 项目不仅有一个README文件,而且还有一个README.md文件。

这些文件有什么区别?我知道README也可以作为项目存储库页面中的介绍性文本,但我不知道是什么README.md

答案1

小编典典

.md 是markdown.
README.md用于生成html您在项目底部看到的摘要。Github 有自己的 Markdown
风格。

优先顺序: 如果你有两个名为READMEandREADME.md的文件,README.md则首选名为的文件,它将用于生成 github
html摘要。


Cmd Markdown 在线编辑Github的README.md文档好帮手

Cmd Markdown 在线编辑Github的README.md文档好帮手

以前都是用老外的在线编辑来写Github的README.md文档说明,

今天杯具了,网站打不开,只好找一下国内的 作业部落出品的mdeditor,

是一款不错的web版工具:
https://www.zybuluo.com/mdeditor

主要功能:

整理知识,学习笔记

发布日记,杂文,所见所想

撰写发布技术文稿(代码支持)

撰写发布学术论文(LaTeX 公式支持)

特性:

支持 LaTeX 编辑显示支持,例如:∑ni=1ai=0, 访问 MathJax 参考更多使用方法

代码高亮功能支持包括 Java, Python, JavaScript 在内的四十一种主流编程语言

flash – 如何将视频嵌入GitHub README.md?

flash – 如何将视频嵌入GitHub README.md?

是否可以在GitHub上的README.md中嵌入一个Flash视频?它不显示: https://github.com/mattdipasquale/PicSciP

解决方法

“ Github Flavored Markdown”不支持任何页面的此类功能:

一个旧的支持线程“在标记文件中嵌入YouTube视频”说:

With pages.github.io,yes,everywhere else,no.

(注:如“Github Top-Level Project Page”中所述,github.io是自2013年4月以来的新域名user and organization pages。
page GitHub publication is presented here)

这可能是一个功能请求像语法高亮是。

例如:“HTML5 video in markdown”(2010年8月):

Is there any way to implement a HTML5 video into the README.markdown file?

  
  目前不是,但我们可能会扩大你可以用READMEs在将来做什么。
  
  在此期间,您可以使用GitHub Pages和我们的Wiki来做到这一点。

Benjamin Oakes在评论中确认(2012年5月):

I sent in a support request. The response was that embedding videos is not supported.

git commit -m ''Add Readme'' 报 error: pathspec ''Readme'''' did not match any file(s) known to git

git commit -m ''Add Readme'' 报 error: pathspec ''Readme'''' did not match any file(s) known to git

原因:ms-dos中使用git commit -m后接的单引号中不能含有空格

解决办法:

法一. 去掉空格

法二. 改用双引号

 

GitHub ReadME.md

GitHub ReadME.md

GitHub ReadME.md

GitHub ReadME.md Grammar

最近提交GitHub时发现有些人的ReadME.md写的非常漂亮,很好奇他们是怎么做到的,于是就搜了一下,原来ReadME.md不仅仅是随便写写的,它是由其特殊的语法的叫Markdown,刚好hexo写文章用的也是Markdown,所以这里列出一些基本的语法,以便于以后写ReadME.md时参考。

二、编辑基本语法 (注意⚠️中间需要有一个空格 )

1、字体格式强调

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

1
2
3
4
5
6
*强调*  (示例:斜体)  
_强调_ (示例:斜体)
**加重强调** (示例:粗体)
__加重强调__ (示例:粗体)
***特别强调*** (示例:粗斜体)
___特别强调___ (示例:粗斜体)

 

标题等级

关于标题还有等级表示法,分为六个等级,显示的文本大小依次减小。不同等级之间是以井号 # 的个数来标识的。一级标题有一个 #,二级标题有两个# ,以此类推。例如:

1
2
3
4
5
6
# 一级标题  
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题

 

2、代码

1
`<hello world>`

3、代码块高亮

三个反引号标签

4、表格 (建议在表格前空一行,否则可能影响表格无法显示)

1
2
3
4
表头  | 表头  | 表头
---- | ----- | ------
单元格内容 | 单元格内容 | 单元格内容
单元格内容 | 单元格内容 | 单元格内容

5、其他引用

图片
1
2
3
![图片名称](https://www.baidu.com/img/bd_logo1.png)
链接
[链接名称](https://www.baidu.com/)

6、列表

1
2
3
4
5
1. 项目1  
2. 项目2
3. 项目3
* 项目1 (一个*号会显示为一个黑点,注意⚠️有空格,否则直接显示为*项目1)
* 项目2

7、换行(建议直接在前一行后面补两个空格)

直接回车不能换行,  
可以在上一行文本后面补两个空格,  
这样下一行的文本就换行了。
或者就是在两行文本直接加一个空行。
也能实现换行效果,不过这个行间距有点大。  

8、引用

1
2
> 第一行引用文字  
> 第二行引用文字
Share
  • GitHub ReadME.md

今天关于GitHub 项目中的 README 和 README.md 有什么区别?github main和master的分享就到这里,希望大家有所收获,若想了解更多关于Cmd Markdown 在线编辑Github的README.md文档好帮手、flash – 如何将视频嵌入GitHub README.md?、git commit -m ''Add Readme'' 报 error: pathspec ''Readme'''' did not match any file(s) known to git、GitHub ReadME.md等相关知识,可以在本站进行查询。

本文标签: