LEADYOU is a web application that helps you to write a README easily.
LEADYOU automatically fills several parts contents such as Project Name, Short Description, and Badges. Additionally you can fill other items we recommend you to fill (Tags, Advantages, Installation, Minimal Example are recommended items).
README GitHub Markdown React TypeScript webpack GitHub Pages GitHub Actions
Just follow the flow of input to create a rich document 🎉
- You can clarify what to write README because LEADYOU gives you specific items to write.
- LEADYOU supports you to write README with auto-fill function.
- Easy to insert demo images because LEADYOU automatically generates necessary links after uploading images to LEADYOU.
- Node.js: 20.11.1+
- npm: 10.2.4+
- LEADYOU needs Node.js (v18) and npm (v9).
- Please download this repository before deploying.
or
git clone git@github.com:Hacknock/leadyou.git
git clone https://github.com/Hacknock/leadyou.git
- Build and view in web browser.
Then, access
npm install npm run start
localhost:3000.
You can add or delete some items to make README using this repository source code.
For example, you want to add "Support".
This item will help your colleagues ask you when they will face a problem with using your software.
You add the following code after lines 178 of /src/json/template.json.
},
{
"title": "Support",
"description": "Please input the contact information when the user faces some problem on using your software.",
"required": false,
"multiple": true,
"hiddenTitle": false,
"replacingTitle": false,
"formType": "one-line-field",
"kindsOfValues": ["plain"],
"formats": ["- %s\n"],
"attributes": {
"placeholder": "[Name](URL)"
}
}You deploy it again, Support item will be on edit form like this screenshot. 🍻
