md 生成目录码云_DuangDuangDuang！码云项目的 Readme.md 特殊技能

原标题：DuangDuangDuang！码云项目的 Readme.md 特殊技能

我们在码云上创建新项目的时候，常常会看到默认使用 README 文件初始化该项目(如图1 所示)，然后在新建项目的根目录下就会生成一个 README.md 文件(如图2 所示)。

图1 默认选中 README

图2 生成 README 文件

那究竟什么是 README ？

它有什么特殊的功能？

我们要如何操作才能写出一个漂亮的 README 呢？

什么是 README.md 文件？

一个合格的老司机想要在码云上了解一个项目，首先都会去翻看该项目的 README 文件，因为这个小小的静态文件其实传达了整个项目的概述，如项目的介绍、代码实现的功能、系统环境参数、部署要素等。

README 文件后缀名为 md，当然扩展名也可能是 txt ，rb 等。md 是 markdown 的缩写，是一种轻量级的「标记语言」。它用「标记」语法，来代替常见的字处理软件中大量的排版格式，从而让大家能够更专注于文字内容，是适合所有人的写作语言。

大家可以通过以下链接来进一步学习 markdown 的写作：

Markdown 语法说明

Markdown 在线工具

如何玩转码云项目的 README.md？

码云上创建 README.md 文件的时候，有一个关于文件内容显示优先级的小窍门分享给大家。

在如图2 所示的根目录下，再创建一个新文件 README.osc.md(或者 README-osc.md 或者 README_osc.md)，大家会发现虽然在根目录下同时存在两个 README 文件，但项目页会优先显示含有 osc 的 README 文件中的内容。

图3 README.md 文件中的内容

图4 README.osc.md 文件中的内容

图5 优先显示README.osc.md 内容

除此之外，当我们使用不同语言创建 README.md 文件时，系统会根据不同的命名规范来判断其显示的优先级，如下所示(优先级从左到右)：

zh-CN 简体时：zh，cn，zh-cn，zh_cn；

zh-TW 繁体时：zh-hk，zh-tw，zh-yue，zh_hk，zh_tw，zh_yue；

en 英文时：en；

README.md 常规模板

如果 README 包括下面的内容，那么当使用者打开项目，浏览 README 后，基本就知道该如何下手了。

项目简介

功能特性

环境依赖

部署步骤

目录结构描述

版本内容更新

声明

协议

当然这不是一个绝对的模板，但是其中有些必要的元素(如项目的介绍，使用，部署及目录结构)还是需要列出来。

如果你也了解码云项目 README 的小窍门，欢迎留言勾搭，分享。如果你还没有使用过码云的话，也欢迎来试试手~

md 生成目录码云_DuangDuangDuang！码云项目的 Readme.md 特殊技能相关推荐

DuangDuangDuang！码云项目的 Readme.md 特殊技能
为什么80%的码农都做不了架构师?>>> 我们在码云上创建新项目的时候,常常会看到默认使用 README 文件初始化该项目(如图1 所示),然后在新建项目的根目录下就会生成 ...
md 生成目录码云_搭建简易博客方案
现在大家都喜欢用markdown来写技术博客,这篇文章将阐述搭建支持markdown的简易博客方法. 我的写作需求通过阅读本文,您将学会搭建满足以下条件的博客: 博客只用书写markdown文件能 ...
README.md模板-中小型项目
前言通过一段时间的查询和研究,总结了一下中小型项目的README.md文件的写法和规范.本篇文章包含README.md的源码和显示效果. 国际开源项目的README.md文件显示效果请见我的另一篇文 ...
Hexo 博客添加 README.md 以及部署到 GitHub 丢失/显示不正常解决方法
GitHub 项目的README.md为自述文件,可对该项目进行介绍,解释等. 使用 Github Pages 和 Hexo 搭建的博客,如果在最开始建立仓库的时候没有创建README.md文件,那么 ...
springboot 建readme_经验分享：给项目创建和编写README.md文件的步骤
在项目开发过程中,不仅要注意代码的编写质量,也要为合作开发打好基础,尤其是合作开发的时候,同事直接的代码需要熟悉,这就需要在开发的时候进行注释操作,方便别人维护和熟悉代码.除了上述两个重要的点之外,还 ...
有道云笔记markdown字体增大、生成目录
字体增大为什么要字体增大字体增大的方法生成目录为什么要生成目录生成目录的方法字体增大为什么要字体增大有道云笔记的可以设置默认字体大小,但是不支持markdown默认字体.当你写完预览m ...
MarkdownPad 2的安装、配置、优化，自定义样式、生成目录，解决win10渲染错误等
文章目录 1.Markdown 介绍 2.Markdown 编辑器 3.MarkdownPad 2 的安装.配置 3.1.下载 3.2.安装 3.3.申请购买序列号 4.异常 4.1.在win10下, ...
wps怎么添加附录_如何将附录生成目录 - 卡饭网
word如何自动生成目录并动态更新 word如何自动生成目录并动态更新在编辑文档的时候,目录有时是必不可少的一项,但在实际情况当中,很多使用者不知道怎样使用word中的目录自动生成的功能,而是自己在 ...
word如何自动生成目录-----如何写软件文档
最近在写软件文档的过程中,目录是必不可少的一项,但是手动写起来非常麻烦,下面我介绍一下如何利用word自动生成目录并动态更新.这里介绍两种方法: 一.利用大纲级别自动生成目录如果要插入目录,请单击& ...

md 生成目录码云_DuangDuangDuang！码云项目的 Readme.md 特殊技能

md 生成目录码云_DuangDuangDuang！码云项目的 Readme.md 特殊技能相关推荐

最新文章

热门文章

md 生成目录 码云_DuangDuangDuang！码云项目的 Readme.md 特殊技能

md 生成目录 码云_DuangDuangDuang！码云项目的 Readme.md 特殊技能相关推荐

最新文章

热门文章

md 生成目录码云_DuangDuangDuang！码云项目的 Readme.md 特殊技能

md 生成目录码云_DuangDuangDuang！码云项目的 Readme.md 特殊技能相关推荐