GitHub中的README文件,使用markdown格式的文件。这种文件语法比较简单,特别容易上手。
Markdown的语法简洁明了、学习容易,而且功能比纯文本更强,因此有很多人用它写博客。世界上最流行的博客平台WordPress和大型CMS如joomla、drupal都能很好的支持Markdown。
下面简单介绍下相关语法:
大标题:
===================================
大标题一般显示工程名,你只要在标题下面跟上=====即可(“=”个数无限制)
中标题:
———————————-
中标题一般显示重点项,你只要在标题下面输入——即可(“-”个数无限制)
小标题:
小标题的格式如下 ### 小标题,注意#和标题字符中间要有空格
也可以使用1到6个“#”来表示六级标题:
# 这是 H1
## 这是 H2
###### 这是 H6
斜体:
可以使用*
或 _
包围文字,例如*Hello World*
加粗:
用两个 *
或 _
包起来的话,达到加粗字体的左右,例如**Hello Markdown**
如果你的 *
和 _
两边都有空白的话,它们就只会被当成普通的符号
单行文本框:
只要两个Tab再输入文字即可
多行文本框:
你可以写入代码等,每行文字只要输入两个Tab再输入文字即可
引用:
引用是使用类似 email 中用 >
的引用方式,例如:> 文字被些字符包围开始,可以在每行上加上“<”,也可以只在首行加上“<”能够达到一样的效果。区块引用可以嵌套(例如:引用内的引用),只要根据层次加上不同数量的 >
:
> 这是第一层引用。
>
> > 这是嵌套的引用块。
>
> 回到第一层。
列表:
无序列表使用星号、加号或是减号作为列表标记,例如:*Red、+Green、-Blue
有序列表则使用数字接着一个英文句点,例如:1.hello;注意,你在列表标记上使用的数字并不会影响输出的 HTML 结果,你可以使用1. Bird 1. McHale 1. Parish
甚至6.ADC 3.EFG 9.XYZ 都可以实现正确的有序列表显示。
超链接:
Markdown 支持两种形式的链接语法: 行内式和参考式两种形式。
不管是哪一种,链接文字都是用 [方括号] 来标记;要建立一个行内式的链接,只要在方块括号后面紧接着圆括号并插入网址链接即可,如果你还想要加上链接的 title 文字,只要在网址后面,用双引号把 title 文字包起来即可,例如:[This link](http://example.net/) has no title attribute
如果你是要链接到同样主机的资源,你可以使用相对路径:See my [About](/about/) page for details
参考式的链接是在链接文字的括号后面再接上另一个方括号,而在第二个方括号里面要填入用以辨识链接的标记:This is [an example][id] reference-style link
接着,在文件的任意处,你可以把这个标记的链接内容定义出来:[id]: http://example.com/ "Optional Title Here"
图片:
图片的语法和超链接非常相似。只显示图片:![github](http://example.com
/unicorn.png “github”);点击图片进入另一个网页:[![image]](http://www.example
.com/) [image]: http://example
.com/example
.png “example
“
相关推荐
预览 Github README.md 在中模仿 repo 主页的预览。 要求 去 1.1 Internet 以便&http.Client{}可以向发出请求 如何使用 $ go get github.com/gedex/preview-github-readme $ preview-github-readme README.md # ...
02-GitHub项目推荐.md
markdown-cheatsheet, 用于 Github README.md的Markdown Cheatsheet Markdown Heading HeadingMarkup : # Heading 1 #-OR-Markup : ============= (below H1 text)标题 2Mark
Grip-GitHub自述文件即时预览 在发送到GitHub之前渲染本地自述文件。 Grip是一个用Python编写的命令行服务器应用程序,它使用呈现本地自述文件。...$ grip AUTHORS.md * Running on http://localh
readme_styles:Github项目的最小README.rst和README.md模板
让Github的README.md完美显示大图先看转换前后的效果对比本项目永久更新地址如何使用本项目?编译好的的软件包,请到本项目的dist目录下自取平台使用方法 |Windows平台1. 将 replace-readme-md-image-win.exe 放入...
提供个目录列表安装使用配合Tampermonkey食用最佳Tip: Internet Explorer 8 及更早 IE 版本不支持,本项目是基于Chrome开发调试,其他浏览器可能会存在些问题,请见谅插件功能项目README.md增加目录侧栏导航功能:...
使用Markdown简短的README.md文件,介绍了如何开始使用Markdown(一种非常简单的网页标记语言)链接入门登录到GitHub。单击+添加一个新的仓库。输入回购的名称(将成为页面的标题)。允许GitHub根据项目类型创建....
前叉存储库,运行“ node index.js” 将创建的文件的内容复制并粘贴到项目的README.md文件中! 完成后删除您的PASTEME.md文件,或保留该文件在下次使用时被覆盖! 技术 HTML,JavaScript,Node / Express.js 执照 ...
使用用户的最近GitHub活动更新README.md 。 指示 在README.md添加注释<!--START_SECTION:activity--> (入口点)。您可以找到示例。 现在是创建工作流文件的时候了。 .github/workflows/update-readme.yml ...
siteleaf更新器 使用存储库的README.md文件更新项目的siteleaf项目的索引文件为什么有必要托管GitHub Pages时,在选择托管其页面文件的位置时会遇到一个普遍的差异。1.将其托管在master分支上master分支托管GitHub ...
open_mailbox_with_raised_flag:拉请求React PullToRefresh组件Typescript和React Chrome Extension Starter NodeJs Express TypeScript GraphQL Starter我的最新文章如何为您的GitHub Pro创建自更新的README.md
github上传项目的方法
github是程序员的宝库,
Sponsors API是一个服务器,用于在您的项目自述文件中显示赞助商头像。看起来像这样: 部署中 部署到支持HTTP的主机,例如使用或Heroku。支持以下环境变量: GITHUB_TOKEN GitHub API令牌(不需要范围) PORT...
github使用教程
editor.md中使用的github emoji 离线表情包图片,用于解决无法加载的问题
github-markdown-toc:为GitHub README.md轻松创建TOC
文档附件为GitHub中markdown写作说明的演示,托管于原作者的GitHub项目,为方便使用引用在博客中,原地址:https://github.com/guodongxiaren/README
English README.md here 功能 支持给Activity定义 URL,这样可以通过 URL 跳转到Activity,支持在浏览器以及 app 中跳入。 集成 1. 添加引用 请根据项目的历史情况选择合适的集成方式 1.1 annotaitonProcessor ...