RichardLitt / Generator Standard Readme
Licence: mit
Scaffold out a Standard Readme
Stars: ✭ 150
Programming Languages
javascript
184084 projects - #8 most used programming language
Projects that are alternatives of or similar to Generator Standard Readme
Standard Readme
A standard style for README files
Stars: ✭ 4,412 (+2841.33%)
Mutual labels: standard, documentation, readme
Jsdoc To Markdown
Generate markdown documentation from jsdoc-annotated javascript
Stars: ✭ 1,199 (+699.33%)
Mutual labels: documentation, readme, generator
Generator
Rails-inspired generator system that provides scaffolding for your apps
Stars: ✭ 1,000 (+566.67%)
Mutual labels: generator, scaffold, yeoman
Generate
A new command line tool and developer framework for scaffolding out GitHub projects. Generate offers the robustness and configurability of Yeoman, the expressiveness and simplicity of Slush, and more powerful flow control and composability than either.
Stars: ✭ 238 (+58.67%)
Mutual labels: generator, scaffold, yeoman
Project Name
Get the name of a project from package.json, git config, or basename of the current working directory.
Stars: ✭ 8 (-94.67%)
Mutual labels: generator, scaffold, yeoman
Papogen
Use Sass/CSS + Pug + Node.js to generate beautiful static website.
Stars: ✭ 37 (-75.33%)
Mutual labels: documentation, generator
Feedmereadmes
Free README editing+feedback to make your open-source projects grow. See the README maturity model to help you keep going.
Stars: ✭ 1,064 (+609.33%)
Mutual labels: documentation, readme
Awesome Readme
A guide to writing an Awesome README. Read the full article in Towards Data Science.
Stars: ✭ 65 (-56.67%)
Mutual labels: documentation, readme
Docsify Tabs
A docsify.js plugin for rendering tabbed content from markdown
Stars: ✭ 65 (-56.67%)
Mutual labels: documentation, generator
Readme Md Generator
📄 CLI that generates beautiful README.md files
Stars: ✭ 9,184 (+6022.67%)
Mutual labels: readme, generator
Generator Rn Toolbox
The React Native Generator to bootstrap your apps
Stars: ✭ 1,155 (+670%)
Mutual labels: generator, yeoman
Ultra light wizard
No time to manage a wizard state machine, session variables, or complicated controllers? Use ultra light wizard!! A RESTful session-less validation-friendly simple multi-step form approach in Rails.
Stars: ✭ 35 (-76.67%)
Mutual labels: generator, scaffold
Generator Swiftserver
WARNING: This repository is no longer maintained
Stars: ✭ 64 (-57.33%)
Mutual labels: generator, yeoman
Generator Angular Auto Admin Loopback
Generator for automatic CRUD angular backend for loopback apps and apis
Stars: ✭ 32 (-78.67%)
Mutual labels: generator, yeoman
Generator Ngx Rocket
🚀 Extensible Angular 11+ enterprise-grade project generator
Stars: ✭ 1,329 (+786%)
Mutual labels: generator, yeoman
Angular Librarian
An Angular 2+ scaffolding setup for creating libraries
Stars: ✭ 92 (-38.67%)
Mutual labels: generator, scaffold
Node Typescript Mongodb
node js typescript mongodb express generator yo
Stars: ✭ 96 (-36%)
Mutual labels: generator, yeoman
Verb Generate Readme
Generate your project's readme with verb. Requires verb v0.9.0 or higher.
Stars: ✭ 127 (-15.33%)
Mutual labels: readme, generator
generator-standard-readme
Scaffold out a Standard Readme
This generator conforms to the standard-readme specification. It creates a minimally compliant standard readme for your cross-language project, with some options.
Tip: Use chalk if you want colors in your CLI.
Table of Contents
Install
This generator requires node, npm, and yeoman.
You can install it by running:
npm install --global yo generator-standard-readme
Usage
With yo:
$ yo standard-readme
This will write a file, readme.md
, to the local directory.
Fields to fill out
standard-readme
will ask you a set of questions, which will help it fill out the README. These are:
- What do you want to name your module?
- What is the description of this module?
- Do have a banner image?
- Where is the banner image? Ex: 'img/banner.png'
- Do you want a TODO dropped where your badges should be?
- Do you want a TODO dropped where your long description should be?
- Do you need a prioritized security section?
- Do you need a background section?
- Do you need an API section?
- What is the GitHub handle of the main maintainer?
- Do you have a CONTRIBUTING.md file?
- Are PRs accepted?
- Is an MIT license OK?
- What is your license?
- Who is the License holder (probably your name)?
- Use the current year?
- What years would you like to specify?
Maintainer
Contributing
Please contribute! Look at the issues.
License
MIT © 2016 Richard Littauer
Note that the project description data, including the texts, logos, images, and/or trademarks,
for each open source project belongs to its rightful owner.
If you wish to add or remove any projects, please contact us at [email protected].