GitHub上README.md使用指南

本文详细介绍了如何在GitHub上创建和编辑README.md文件,包括标题的设置、文本格式化、插入符号、图片和代码片段等。Markdown语法的使用使得README文件更具可读性和展示性,同时提供了一种简洁的文档编写方式。
摘要由CSDN通过智能技术生成

README文件后缀名为md。md是markdown的缩写,markdown是一种编辑博客的语言。用惯了可视化的博客编辑器(比如CSDN博客,囧),这种编程式的博客编辑方案着实让人眼前一亮。不过GitHub支持的语法在标准markdown语法的基础上做了修改,称为Github Flavored Markdown,简称GFM。可不是GFW呀偷笑

高仿斗鱼Tv界面喜欢的可以看看

开始编辑README

打开你的GitHub的某个项目,我们可以直接在线编辑你的README文件,如果你已经有了这个文件,则在文件目录中直接点击它,如果你还没有这个文件那么点击项目名称右边的一个按钮,来添加新文件:


然后你就打开了编辑页面,编辑区的左上角有填写文件名的区域,注意加上后缀.md


如果你本来就有这个文件要重新编辑它的话,那么在点击了文件目录中的该文件后,在上方有工具栏,选择Edit


然后滚动屏幕到下面,如果是新文件会有一个Commit new file的按钮,若没有内容是不能点击的。如果是旧文件重修编辑,那么这个按钮显示的是 Commit changes


关于标题

规范的README文件开头都写上一个标题,这被称为大标题

[plain]  view plain copy 在CODE上查看代码片 派生到我的代码片
  1. 大标题  
  2. ====  

效果图:点击打开链接

在文本下面加上 等于号 = ,那么上方的文本就变成了大标题。等于号的个数无限制,但一定要大于0个哦。。

比大标题低一级的是中标题,也就是显示出来比大标题小点。

[plain]  view plain copy 在CODE上查看代码片 派生到我的代码片
  1. 中标题  
  2. -------  

在文本下面加上 下划线 - ,那么上方的文本就变成了中标题,同样的 下划线个数无限制。

除此之外,你也会发现大,中标题下面都有一条横线,没错这就是 = 和 - 的显示结果。

如果你只输入了等于号=,但其上方无文字,那么就只会显示一条直线。如果上方有了文字,但你又只想显示一条横线,而不想把上方的文字转义成大标题的话,那么你就要在等于号=和文字直接补一个空行。

补空行:是很常用的用法,当你不想上下两个不同的布局方式交错到一起的时候,就要在两种布局之间补一个空行。

如果你只输入了短横线(减号)-,其上方无文字,那么要显示直线,必须要写三个减号以上。不过与等于号的显示效果不同,它显示出来时虚线而不是实线。同减号作用相同的还有星号*和下划线_,同样的这两者符号也要写三个以上才能显示一条虚横线。

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

[plain]  view plain copy 在CODE上查看代码片
`readme.md`文件是一个项目的自述文件,通常用于在GitHub等代码托管平台上向用户展示项目的相关信息。一个清晰、详细的`readme.md`可以帮助用户快速了解项目的用途、安装方法、使用方法、贡献指南、许可证信息等。一个典型的`readme.md`目录结构可能如下: ```markdown # 项目名称 简介:简短介绍项目的主要功能和用途。 ## 目录 - [配置选项](#配置选项) - [常见问题解答](#常见问题解答) - [贡献指南](#贡献指南) - [许可证](#许可证) ## 安装 提供项目的安装步骤,可能包括依赖安装、环境配置等。 ## 快速开始 描述如何快速运行一个示例或者演示项目的基本功能。 ## 功能特性 列出项目的主要功能或者特性,以及它们的简短描述。 ## 使用方法 详细介绍如何使用项目,可能包含命令行选项、API文档、图形界面操作等。 ## 配置选项 如果项目允许配置,这里应列出所有可用的配置选项和它们的作用。 ## 常见问题解答 解答用户可能遇到的常见问题。 ## 贡献指南 说明如何为项目做出贡献,包括代码提交、文档编、社区参与等。 ## 许可证 声明项目所使用的开源许可证。 ## 联系方式 提供项目维护者的联系方式,如电子邮件、论坛等。 ## 致谢 感谢对项目有贡献的个人或团队。 ``` 以上是一个`readme.md`的目录结构示例。实际编时,应该根据项目的实际情况进行相应的调整和补充。Markdown格式支持标题、列表、链接、图片等元素,可以增强文档的可读性和信息的组织性。
评论 3
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值