https://docs.github.com/zh/enterprise-server@3.5/get-started/quickstart/hello-world GitHub Enterprise Server 是一个用于版本控制和协作的代码托管平台。
https://docs.github.com/zh/get-started/quickstart/set-up-git
基本撰写和格式语法
使用简单的语法在 GitHub 上为您的散文和代码创建复杂的格式。
标题
要创建标题,请在标题文本前添加一至六个 # 符号。 你使用的 # 数量将决定标题的大小。
# The largest heading ## The second largest heading ###### The smallest heading
使用两个或多个标题时,GitHub 会自动生成一个目录,可以通过单击文件标题中的 来访问该目录。 每个标题都列在目录中,可以单击某个标题导航到所选部分。
文本样式
可以在评论字段和 .md 文件中以粗体、斜体、删除线、下标或上标文本表示强调。
Style | 语法 | 键盘快捷键 | 示例 | 输出 |
---|---|---|---|---|
加粗 | ** ** 或 __ __ | Command+B (Mac) 或 Ctrl+B (Windows/Linux) | **This is bold text** | 这是粗体文本 |
斜体 | * * 或 _ _ | Command+I (Mac) 或 Ctrl+I (Windows/Linux) | *This text is italicized* | 这是斜体文本 |
删除线 | ~~ ~~ | ~~This was mistaken text~~ | 这是错误文本 | |
粗体和嵌入的斜体 | ** ** 和 _ _ | **This text is _extremely_ important** | 此文本非常重要 | |
全部粗体和斜体 | *** *** | ***All this text is important*** | 所有这些文本都很重要 | |
下标 | <sub> </sub> | <sub>This is a subscript text</sub> | 这是下标文本 | |
上标 | <sup> </sup> | <sup>This is a superscript text</sup> | 这是上标文本 |
引用文本
可以使用 > 来引用文本。
链接
通过将链接文本用方括号 [ ] 括起来,然后将 URL 用括号 ( ) 括起来,可创建内联链接。 还可以使用键盘快捷方式 Command+K 创建链接。 选择文本后,可以粘贴剪贴板中的 URL 以自动从所选内容创建链接。
还可以通过突出显示文本并使用键盘快捷方式 Command+V 创建 Markdown 超链接。 如果要将文本替换为链接,请使用键盘快捷方式 Command+Shift+V。
章节链接
您可以直接链接到渲染文件中的某个部分,方法是将鼠标悬停在该部分标题上以显示链接:
relative links (相对链接)
您可以在渲染的文件中定义相对链接和图像路径,以帮助读者导航到仓库中的其他文件。
相对链接是相对于当前文件的链接。 例如,如果在仓库根目录下有一个自述文件,而在 docs/CONTRIBUTING.md 中有另一个文件,则自述文件中的 CONTRIBUTING.md 的相关链接如下所示
图像
通过添加 ! 并 将 alt 文本用 [ ] 括起来,可显示图像。 然后将图像的链接用括号 () 括起来。
列表
可通过在一行或多行文本前面加上 -、* 或 + 来创建一个无序列表。
要对列表排序,请在每行前面添加一个编号。
经常逛gitHub就会发现,有很多用户的介绍页面花里胡哨的各种 GitHub 数据卡片和徽章,今天就跟大家分享一下,这些东西怎么做!
后续我会把这些放到这个 readme-become-better 项目里了
自述记录统计数据 ( 成功 )
卡片链接:https://github-readme-streak-stats.herokuapp.com?user=dongyuanwai&theme=radical
point_down把下面的这段代码复制到你的README.md文档中,将username=自己的gitHub名字,就可以得到卡片样式
1 | <div align="center"><img src="https://github-readme-streak-stats.herokuapp.com?user=dongyuanwai&theme=onedark&date_format=M%20j%5B%2C%20Y%5D" /></div> |
统计卡片 ( 成功 )
stats卡片链接:https://github-readme-stats.vercel.app/api?username=dongyuanwai&theme=dark&show_icons=true
把下面的这段代码复制到你的README.md文档中,将username=自己的gitHub名字,就可以得到卡片样式

gitHub-readme文档可以不仅可以使用mardown语法,还支持html语法。所以你可以进行插入图片、设置位置等操作
point_down把下面的这段代码复制到你的README.md文档中,将username=自己的gitHub名字,就可以得到卡片样式
1 | <div align="center"><img src="https://github-readme-stats.vercel.app/api?username=dongyuanwai&show_icons=true&theme=radical&hide=contribs,prs" /></div> |
热门语言卡片
热门语言链接:https://github-readme-stats.vercel.app/api/top-langs/?username=oldUath
point_down把下面的这段代码复制到你的README.md文档中,将username=自己的gitHub名字,就可以得到卡片样式

通过对链接尾部传不同的参数,可以控制卡片的布局,和样式
point_down把下面的这段代码复制到你的README.md文档中,将username=自己的gitHub名字,就可以得到卡片样式
1 2 3 | <div align="center"> <img src="https://github-readme-stats.vercel.app/api/top-langs/?username=dongyuanwai&layout=compact" /> </div> |
Leave A Comment