最简单方法创建 README

简介: 最简单方法创建 README

一、简介

名称:readme.so

类型:网站

官网地址:https://readme.so/cn

便捷提示一个优秀的readme文件的工具,小而美的网站。

二、解决的问题

在项目的根目录,我们通常都会编写readme文件,来告诉大家项目是做什么的。

某种程度上讲,在Github上,拥有完整的readme,是实验项目和成熟项目的最明显的区别。

而这个网站,就可以帮助我们完成一份完整的readme文件。

三、使用说明

1. 进入网站

进去网站,可以选择各种语言,这里我们选择中文简体。

工具类文本不多的网站建议大家都做一下国际化(I18N),用起来很舒服。

2. 组件选择

编辑器地址为 https://readme.so/editor ,点击起步按钮也是一样。

我们可以看到编辑器分为三个部分。

这个可以说是这个网站的核心,他告诉了我们readme组成的都会有哪些部分。

3. 编辑器 & 预览

中间这部分就是md编辑器了。

有意思的是,点击组件之后,默认会有如何写好readme的链接,可以说是很贴心了。

最右侧则是实时预览和源文件展示,支持一键复制。

4. 导出按钮

页面右上角是导出按钮,我们可以直接下载编辑好的readme文档。

左边是夜间模式。

四、缺点和不足

作为小而美的工具网站,可以说没啥缺点。

五、总结

对于readme编写不熟练的开发者来说,这个工具非常不错,建议加入收藏夹。


相关文章
|
3月前
|
应用服务中间件 nginx
Docsify——部署后显示404且无法访问README.md
Docsify——部署后显示404且无法访问README.md
34 0
cp mv rm命令,cp 第一个是复制的文件夹,第二个表示复制去的地方,如果复制文件夹需带-r,mv test.txt Desktop/移动文件,mv test2.txt test3.txt不存
cp mv rm命令,cp 第一个是复制的文件夹,第二个表示复制去的地方,如果复制文件夹需带-r,mv test.txt Desktop/移动文件,mv test2.txt test3.txt不存
给项目写README文档
给项目写README文档
91 0
|
开发工具 git
git clone 命令只下载了一个readme文件
git clone 命令只下载了一个readme文件
417 0
|
JavaScript
在 README.md 中生成项目目录结构
在 README.md 中生成项目目录结构
1261 0
在 README.md 中生成项目目录结构
ReadMe2.txt 文件内容拷贝 到 新的ReadMe.txt 分析 : 拷贝: 从ReadMe2.txt读取 写入到ReadMe.txt 1.创建两个文
ReadMe2.txt 文件内容拷贝 到 新的ReadMe.txt 分析 : 拷贝: 从ReadMe2.txt读取 写入到ReadMe.txt 1.创建两个文
|
开发工具 数据库 git
Git是如何保存文件名和目录关系的---树对象
本文首发于公众号“AntDream”,欢迎微信搜索“AntDream”或扫描文章底部二维码关注,和我一起每天进步一点点 树对象(tree)—— 保存文件名和目录关系 树对象主要解决2个问题,:文件名的保存和文件目录关系的保存 就像下面这样 下面我们就来模拟一下构建上面这颗树,也就是模拟保存这3个文件,其中的"bak"是一个目录,下面有一个文件 首先可以看到,我们一共需要保存的是3个文件,new.txt 、 内容为version 2的 test.txt 和内容为version 1的 test.txt。
800 0
|
Java 开发工具 git
|
机器学习/深度学习 Python
查找某文件夹下所有子文件夹内的py文件-3 一行代码搞定
转自:https://mp.weixin.qq.com/s/FFXh8gRci4hMo6_gnBMPUg       工作中,有时会产生查找某一类文件的需求,比如log文件。或者在做图像类深度学习时,需要读取大类文件夹下,所有小类文件夹下的图片。
1431 0
|
开发工具 git
新建/初始化git项目
Command line instructions Git global setup git config --global user.name "你的名字" git config --global user.
963 0