最简单方法创建 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月前
|
Java
java中实现File文件的重命名(renameTo)、将文件移动到其他目录下、文件的复制(copy)、目录和文件的组合(更加灵活方便)
这篇文章介绍了Java中使用`renameTo()`、`Files.copy()`等方法对文件进行重命名、移动和复制的操作,并提供了代码实例和测试效果。
java中实现File文件的重命名(renameTo)、将文件移动到其他目录下、文件的复制(copy)、目录和文件的组合(更加灵活方便)
|
3月前
|
应用服务中间件 nginx
Docsify——部署后显示404且无法访问README.md
Docsify——部署后显示404且无法访问README.md
30 0
|
缓存 IDE 编译器
Git文件.gitignore和.gitkeep用法解析
Git文件.gitignore和.gitkeep用法解析
629 0
给项目写README文档
给项目写README文档
91 0
|
开发工具 git
git clone 命令只下载了一个readme文件
git clone 命令只下载了一个readme文件
406 0
|
存储 Java 开发工具
Git文件.gitignore、.gitattributes、.gitkeep用法解析
.gitignore、.gitattributes、.gitkeep都是常见的Git相关文件,本文介绍它们到底该如何使用。
769 0
|
JavaScript
在 README.md 中生成项目目录结构
在 README.md 中生成项目目录结构
1251 0
在 README.md 中生成项目目录结构
|
Shell 开发工具 git
GIT03_初始化init、查看状态status、添加add、删除rm、commit提交、历史版本reflog、忽略文件gitignore(二)
③. 初始化坏境配置 init ④. 查看文件状态 status ⑤. 添加到暂存区、撤回到工作目录 add|reset
157 0
GIT03_初始化init、查看状态status、添加add、删除rm、commit提交、历史版本reflog、忽略文件gitignore(二)
|
存储 Shell 网络安全
|
缓存 开发工具 git