GitHub上如何写README.md

最新推荐文章于 2023-09-30 16:28:14 发布
最新推荐文章于 2023-09-30 16:28:14 发布
阅读量289 收藏
点赞数
分类专栏： 编程小知识 文章标签： github
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/AC__GO/article/details/77852021
版权

标题

#一级标题  
##二级标题  
###三级标题  
。。。

‘#’后面打一个Ｔａｂ;

普通文本显示

换行

这是一段普通的文本，  
直接回车不能换行，<br>  
要使用\<br>

高亮

一句话｀高亮的话｀一句话

｀｀是Ｔａｂ上面数字１左面的键

圆点

* 昵称：果冻虾仁  
* 别名：隔壁老王  
* 英文名：Jelly

*后面打一个Ｔａｂ

AC__GO
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
GitHub上README写法暨GFM语法解读
weixin_30730053的博客
04-15 2629
转载请保留原作者guodongxiaren的原文地址。 自从开始玩GitHub以来，就越来越感觉它有爱。最近对它的README.md文件颇为感兴趣。便写下这贴，帮助更多的还不会编写README文件的同学们。 README文件后缀名为md。md是markdown的缩写，markdown是一种编辑博客的语言。用惯了可视化的博客编辑器（比如CSDN博客，囧），这种编程式的博客编辑方案着实...
README.md文档编写
lvfeng19806001的专栏
03-29 922
参考：README.md文档编写 - yeshenmeng - 博客园文章参考自：如何为开发项目编写规范的README文件（windows），此文详解 - 战争热诚 - 博客园 (cnblogs.com) 为什么要写这篇博客？ 其实我是一个入坑已经半年的程序员，因为不是https://www.cnblogs.com/yeshenmeng/p/15380687.html ...
GitHub README.md 语法
遇见更好的自己
06-15 461
大标题   ===================================       大标题一般显示工程名,类似html的\     你只要在标题下面跟上=====即可   中标题   -----------------------------------       中标题一般显示重点项,类似html的\     你只要在标题下面输
github中（.md）文件markdown基本语法
刘鑫磊
03-13 2203
文章目录： 一：段落格式 1.换行 2.标题 3.字体 3.1 斜体 3.2 粗体 3.3 粗斜体 4.分割线 5. 删除线 二：贴gif图片 三：图片 四：链接 五：代码 六：列表 七：区块 一：段落格式 1.换行 在行尾敲两个以上空格 2.标题 # 一级标题 ## 二级标题 ### 三级标题 #### 四级标题 ##### 五级标题 ###### 六级标题 3.字体 3.1 斜体 *斜体文本* 3.2 粗体 ...
【README.md 指南 】如何编写 README.md：打造出色的开源项目文档
最新发布
探索C++编程的奥秘，分享深入的技术见解和实践，旨在激发读者创造力与解决问题的思维。
09-30 2089
README.md 不仅是项目的入口，更是项目的名片。它向访问者展示了项目的目标、功能和使用方法。一个详尽、清晰的 README 能够帮助开发者快速理解项目的价值和用途，从而决定是否要使用或参与该项目。
iammiguelmx:我使用GitHub Action生成README.md
04-04
你好呀 :waving_hand: :construction_worker: 看看我目前在做什么消费者cliente Web Service Converter Temp（6天前） （1周前） -Api（2周前） 学习烧瓶 :rocket: （2个月前） 实时简单聊天 :sparkles: （3个月前）...
ZaidKhan144：Github配置文件ReadMe.md
02-13
嗨，我是Zaid :waving_hand: 由前QA测试人员转变为Web开发人员 :telescope: 我目前正在寻找前端开发人员，因此，如果您想一起工作，请随时通过或与我联系。 ‍:laptop_computer: 我的 :hammer_and_wrench: 我 ...
md-list:github、码云项目README.md增加目录侧栏导航
05-29
提供个目录列表安装使用配合Tampermonkey食用最佳Tip: Internet Explorer 8 及更早 IE 版本不支持，本项目是基于Chrome开发调试，其他浏览器可能会存在些问题，请见谅插件功能项目README.md增加目录侧栏导航功能：...
技巧：在提交之前先在本地预览GitHub README.md文件
02-03
在OS X上，您还可以使用Homebrew进行安装： $ brew install grip 用法 呈现存储库的自述文件： $ cd myrepo $ grip * Running on http://localhost:6419/ 现在打开浏览器并访问 。 或者使用-b运行，Grip将为您...
readme_styles：Github项目的最小README.rst和README.md模板
02-04
readme_styles：Github项目的最小README.rst和README.md模板
goodshort：特殊的GitHub个人资料README.md
03-04
我是谁？ :briefcase: 工作 我在安装和许可团队的工作 我目前正在开发MATLAB Web应用程序，以提高团队的工作效率 :seedling: 我 最近毕业于 我可以做所有事情（java，python，bash，MATLAB ...） ...
解决提交README.md到github后，图片无法显示问题
01-07
最近自己开发了一个React项目，想要把项目代码上传到github，并在README中详细说明项目的过程，其中就需要插入对于项目的截图。一开始，我只是在README中使用图片的本地地址，然而，README上传后却无法显示图片。...
preview-github-readme:Go app 预览你的 GitHub 的 README.md
07-09
预览 Github README.md 在中模仿 repo 主页的预览。 要求 去 1.1 Internet 以便&http.Client{}可以向发出请求 如何使用 $ go get github.com/gedex/preview-github-readme $ preview-github-readme README.md # ...
readme-generator:用于为 Github 项目创建 readme.md 文件的生成器
06-11
自述文件生成器 为您的开源项目轻松生成 Github 风格的自述降价文件。 设置 为了设置这个项目，你需要克隆这个存储库： $ git clone https://github.com/eshaham/angular-gulp.git
emilyplusplus：我的GitHub个人资料README.md的特殊存储库
02-18
嗨，我叫艾米丽，很高兴认识你。 :waving_hand: 我是一个伟大的怪胎，喜欢不断学习，并且热情洋溢地解决问题！ :seedling: 我目前正在学习基于Vue的静态网站生成器 :people_with_bunny_ears: 我希望开始建立与网络...
如何写好README.md文件
li1784506的博客
03-22 1654
在github上阅读源码时，为更快速了解代码结构需先阅读README.md文件。
Github README.md编写指南
莫邪莫急的博客
01-30 6411
以MMdnn项目为例，总结开源项目README.md的一般编写套路。从内容和展示形式两方面进行说明。 内容 README.md最好要包含： 项目名称及简介 项目特点 项目安装指南 项目功能及使用指南 使用范例 其他说明 展示形式 基本内容 下面是README.md子版块内容示例，它基本呈现了编写某板块内容的几个要素及其展示形式： 标题：项目名称采用一级标题，因此其子块内容多采用二级、三...
Github上的README.md基本写法
weixin_42795141的博客
04-15 5309
本人今天也是第一次接触markdown，通过一天的各种尝试和探究，总结出了一些基本的用法，我就分享在这里： 标题写法 标题分为六个等级，显示的文本大小会依次减小。依次用一到六个 # 来区分等级，一级标题有一个 #，依次类推。注意的是在 # 和标题之间有一个空格。 一级到六级标题如下：# 这是一级标题 ## 这是二级标题 ### 这是三级标题 #### 这是四级标题 ##### 这是五级标题 ##...
GitHub上README.md编写教程（基本语法）
热门推荐
无名的一棵小树
06-25 5万+
今天在编写github中的readme.md文档时，发现自己写的和别人写的样式完全不一样，自己的好难看，于是百度了一番，很多都是转载的别人13年的博客，其中还发现一片17年写的原创，本以为发现了一个新的文章，结果发现其实就是转载的别人13年的博客，一个字都没修改居然可以编辑为原创，真心服了哪位仁兄了，本来打算在他文章底部评论的，最后想想算了吧。一番百度后，根据他人的博客重新归正了下。 参考博客：...
github readme.md文档规范
03-16
GitHub 的 README.md 文档规范是指在 GitHub 上创建项目时，需要编写一个 README.md 文件来介绍项目的内容、使用方法、贡献者等信息。这个文件需要遵循一定的规范，包括使用 Markdown 语法、添加项目标题、描述、...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值