如何让你的开源项目更有展现力?

原创

趣谈前端 2022-01-17 11:32:04 ©著作权

文章标签 html js css java javascript 文章分类 开源

©著作权归作者所有：来自51CTO博客作者趣谈前端的原创作品，请联系作者获取转载授权，否则将追究法律责任

播种希望

如何让你的开源项目更有展现力?_javascript

如何让你的开源项目更有展现力?_javascript_02

今天讲的内容不是纯纯的技术干货, 而是笔者在做开源项目中用到的一些工具, 可以让我们的开源项目更加富有展现力, 最后会同步一下H5-Dooring 页面编辑器和V6.Dooring可视化大屏编辑器的一些更新.

如何让你的开源项目有个漂亮的README.md ?

逛了一圈社区之后笔者发现了readme-md-generator

readme-md-generator通过阅读我们的package.json和git配置来建议我们使用对应的readme结构。

如何让你的开源项目更有展现力?_css_03

产生的README.md类似如下展现：

如何让你的开源项目更有展现力?_java_04

另外, 一个优秀的package.json应该包含如下几个元数据:

{
  "name": "H5-Dooring",
  "version": "1.1.3",
  "description": "H5-Dooring是一款功能强大，开源免费的H5可视化页面配置解决方案，致力于提供一套简单方便、专业可靠、无限可能的H5落地页最佳实践。技术栈以react为主， 后台采用nodejs开发。",
  "author": "作者信息",
  "license": "开源协议",
  "homepage": "主页地址",
  "repository": {
    "type": "git",
    "url": "git仓库地址"
  },
  "bugs": {
    "url": "供他人提issue的地址"
  },
  "engines": {
    "npm": ">=5.5.0",
    "node": ">=9.3.0"
  }
}