最近在用gitlab,项目提交上去之后还是想着再写个文档来描述项目的主要业务。其实,这在github上经常用README.md文件来说明。
EADME文件后缀名为md。md是markdown的缩写,markdown是一种编辑博客的语言。
不过GitHub支持的语法在标准markdown语法的基础上做了修改,称为Github Flavored Markdown,简称GFM。
写法笔记
1、大标题的写法
大标题
====
大标题下方写"="后,就会变成大标题,"="个数不限,大于0即可
2、中标题的写法
中标题
____
中标题下方写"_"后,上面的文本就会变为中标题,中标题字段稍小一点,下划线个数大于0即可
除此之外,你也会发现大,中标题下面都有一条横线,没错这就是 = 和 - 的显示结果。
如果你只输入了等于号=,但其上方无文字,那么就只会显示一条直线。如果上方有了文字,但你又只想显示一条横线,而不想把上方的文字转义成大标题的话,那么你就要在等于号=和文字直接补一个空行。
补空行:是很常用的用法,当你不想上下两个不同的布局方式交错到一起的时候,就要在两种布局之间补一个空行。
如果你只输入了短横线(减号)-,其上方无文字,那么要显示直线,必须要写三个减号以上。不过与等于号的显示效果不同,它显示出来时虚线而不是实线。同减号作用相同的还有星号*和下划线_,同样的这两者符号也要写三个以上才能显示一条虚横线。
除此以外,关于标题还有等级表示法,分为六个等级,显示的文本大小依次减小。不同等级之间是以井号 # 的个数来标识的。一级标题有一个 #,二级标题有两个# ,以此类推。
注意井号#和标题名称要并排写作一行
实际上,前文所述的大标题和中标题是分别和一级标题和二级标题对应的。即大标题大小和一级标题相同,中标题大小和二级标题相同。
普通文本:
直接输入的文字就是普通文本。需要注意的是要换行的时候不能直接通过回车来换行,需要使用<br>(或者<br/>)。也就是html里面的标签。事实上,markdown支持一些html标签,你可以试试。当然如果你完全使用html来写的话,就丧失意义了,毕竟markdown并非专门做前端的,然而仅实现一般效果的话,它会比html写起来要简洁得多得多啦。
超链接:
直接写url,会自动转换成超链接
文字超链接
给一段文字加入超链接的格式是这样的 [ 要显示的文字 ]( 链接的地址 )。比如:
我的文本(http://sxabu.iteye.com)
待续。。。
分享到:
相关推荐
**开源的README.md编写工具** 在软件开发领域,README文件是项目的重要组成部分,它提供了项目的概述、安装指南、使用说明以及贡献方式等信息。随着Markdown的流行,许多开发者选择使用Markdown格式来编写README,...
预览 Github README.md 在中模仿 repo 主页的预览。 要求 去 1.1 Internet 以便&http.Client{}可以向发出请求 如何使用 $ go get github.com/gedex/preview-github-readme $ preview-github-readme README.md # ...
const readmeContent = fs.readFileSync('Readme.md', 'utf8'); const htmlContent = marked(readmeContent); // 将生成的HTML写入新的文件 fs.writeFileSync('index.html', htmlContent); ``` 虽然这会生成一个...
`readme_styles`项目提供了GitHub项目的最小化`README.rst`(reStructuredText)和`README.md`(Markdown)模板,帮助开发者快速构建专业且规范的项目介绍文档。 首先,我们来详细了解一下`README`文件的重要性。`...
提供个目录列表安装使用配合Tampermonkey食用最佳Tip: Internet Explorer 8 及更早 IE 版本不支持,本项目是基于Chrome开发调试,其他浏览器可能会存在些问题,请见谅插件功能项目README.md增加目录侧栏导航功能:...
Grip-GitHub自述文件即时预览 在发送到GitHub之前渲染本地自述文件。 Grip是一个用Python编写的命令行服务器应用程序,它使用呈现本地自述文件。...$ grip AUTHORS.md * Running on http://localh
使用用户的最近GitHub活动更新README.md 。 指示 在README.md添加注释<!--START_SECTION:activity--> (入口点)。您可以找到示例。 现在是创建工作流文件的时候了。 .github/workflows/update-readme.yml ...
hexo-Github搭建个人博客.md
【标题】"travisbyr:我的GitHub个人资料README.md显示了UI元素的可能性"揭示了GitHub个人主页的自定义潜力。在GitHub上,用户可以通过创建一个名为`README.md`的文件来展示自己的个人资料,利用Markdown语法来创建...
markdown-cheatsheet, 用于 Github README.md的Markdown Cheatsheet Markdown Heading HeadingMarkup : # Heading 1 #-OR-Markup : ============= (below H1 text)标题 2Mark
让Github的README.md完美显示大图先看转换前后的效果对比本项目永久更新地址如何使用本项目?编译好的的软件包,请到本项目的dist目录下自取平台使用方法 |Windows平台1. 将 replace-readme-md-image-win.exe 放入...
open_mailbox_with_raised_flag:拉请求React PullToRefresh组件Typescript和React Chrome Extension Starter NodeJs Express TypeScript GraphQL Starter我的最新文章如何为您的GitHub Pro创建自更新的README.md
生成并维护任何Markdown文档的目录,尤其是托管在github上的README.md文件。 目录 安装 全球范围 $ npm install -g toctoc 在本地 $ npm install toctoc --save-dev 设置 程序将扫描传递的文件内容,并查找TOC占位...
最近自己开发了一个React项目,想要把项目代码上传到github,并在README中详细说明项目的过程,其中就需要插入对于项目的截图。一开始,我只是在README中使用图片的本地地址,然而,README上传后却无法显示图片。...
02-GitHub项目推荐.md
你好呀 :waving_hand: :construction_worker: 看看我目前在做什么消费者cliente Web Service Converter Temp(6天前) (1周前) -Api(2周前) 学习烧瓶 :rocket: (2个月前) 实时简单聊天 :sparkles: (3个月前)...
使用Markdown简短的README.md文件,介绍了如何开始使用Markdown(一种非常简单的网页标记语言)链接入门登录到GitHub。单击+添加一个新的仓库。输入回购的名称(将成为页面的标题)。允许GitHub根据项目类型创建....
嗨,我是Zaid :waving_hand: 由前QA测试人员转变为Web开发人员 :telescope: 我目前正在寻找前端开发人员,因此,如果您想一起工作,请随时通过或与我联系。 :laptop_computer: 我的 :hammer_and_wrench: 我 ...
自述文件生成器 为您的开源项目轻松生成 Github 风格的自述降价文件。 设置 为了设置这个项目,你需要克隆这个存储库: $ git clone https://github.com/eshaham/angular-gulp.git
文档附件为GitHub中markdown写作说明的演示,托管于原作者的GitHub项目,为方便使用引用在博客中,原地址:https://github.com/guodongxiaren/README