一、简介
名称: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编写不熟练的开发者来说,这个工具非常不错,建议加入收藏夹。