🏷️ readme-md-generator

确保你已经安装了npx (npx从npm 5.2.0开始默认安装)

执行命令

只需在项目的根目录下运行以下命令并回答问题:

npx readme-md-generator

在项目根目录执行上面bash命令，结果：

# npx readme-md-generator
D:\vinca\site\pages>npx readme-md-generator
? 🎨  Use HTML in your README.md for a nicer rendering? (not supported everywhere. ex: Bitbucket) No
√ README template path resolved
√ Project infos gathered
? 💡  Project name 项目名称
? ℹ️  Project version (use empty value to skip) v1.0.0
? 📄  Project description 构建README.md
? 🏠  Project homepage (use empty value to skip) localhost:3000
? ✨  Project demo url (use empty value to skip) test:8080
? 📘  Project documentation url (use empty value to skip) localhost:3000/document.html
? 👤  Author name @Vinca
? 👤  GitHub username (use empty value to skip) null
? 🏠  Author website (use empty value to skip)
? 🐦  Twitter username (use empty value to skip)
? 💼  LinkedIn username (use empty value to skip)
? ❤️  Patreon username (use empty value to skip)
? 📝  License name (use empty value to skip)
? 🔧  Issues page url (use empty value to skip)
? 🤝  Contributing guide url (use empty value to skip)
? 📦  Install command (use empty value to skip) npm install
? 🚀  Usage command or instruction (use empty value to skip) npm run dev
? ✅  Test command (use empty value to skip)
√ README template loaded
√ README created


╔═══════════════════════════════════════════╗
║                                           ║
║   README.md was successfully generated.   ║
║   Thanks for using readme-md-generator!   ║
║                                           ║
╚═══════════════════════════════════════════╝

附上我的操作执行图

更多操作

或者对所有问题使用默认值(-y):
Or use default values for all questions (-y):

npx readme-md-generator -y

使用你自己的ejs README模板(-p):
Use your own ejs README template (-p):

npx readme-md-generator -p path/to/my/own/template.md

心得

• （npx readme-md-generator -p path/to/my/own/template.md）使用README模板比较人性化。
• （npx readme-md-generator）过于国际化了，很多问题并不适合国内开发者。
• （npx readme-md-generator -y）单纯快捷创建一个md文件，作用不大。

🏷️ readme.so

视图化操作

 国际化

实际操作

实际操作人性化，需要什么直接点击左侧组件就会添加到文档中，你可以在代码视图中编辑它，当然你需要掌握一定的md语法。如果你还不熟悉可以查看Markdown 官方教程

下载到本地

点击页面右上角Download按钮即可下载到本地，你只需要将他移动到你项目根目录即可。如

心得

• 非常不错的一款在线README.md编写工具

1. 支持拖拽排序，你完全不用担心排版的问题
2. 支持全部重置、单项删除操作
3. 支持在线预览即编写即所得，同时支持Markdown语法（Raw) 查看编码格式

• 你可以通过它（readme.so）指定自己的README.md模板，结合 readme-md-generator一起使用
• 如果你需要英文版README，只需要编译更换名称就好😃

🔖 工具官方地址

readme-md-generator - npm (npmjs.com)

readme.so

Markdown 官方教程