blueprint.json

{
	"package": "package.json",
	"blueprint": "blueprint.md",
	"input": "blueprint.md",
	"output": "README.md",
	"text": "Use this readme generator to easily generate beautiful readme's like this one! Simply extend your <code>package.json</code> and create a readme blueprint. On Github, the README file is like the landing page of your website because it is the first thing visitors see. You want to make a good first impression.",
	"logo": {
		"src": "https://raw.githubusercontent.com/andreasbm/readme/master/assets/logo-shadow.png",
		"width": 150,
		"height": 150
	},
	"placeholder": [
		"[[",
		"]]"
	],
	"documentationConfig": {
		"markdown": {
			"titleLevel": 2
		}
	},
	"ids": {
		"github": "andreasbm/readme",
		"npm": "@appnest/readme"
	},
	"badges": [
		{
			"alt": "Custom badge",
			"url": "https://github.com/badges/shields",
			"img": "https://img.shields.io/badge/custom-badge-f39f37.svg"
		},
		{
			"alt": "Maintained",
			"img": "https://img.shields.io/badge/Maintained%3F-yes-green.svg",
			"url": "https://github.com/andreasbm/readme/graphs/commit-activity"
		}
	],
	"bullets": {
		"Simple": "Extremely simple to use - so simple that it almost feels like magic!",
		"Powerful": "Customize almost everything - add your own templates and variables if you like",
		"Awesome": "The tool you don't know you need before you have many different repositories that all need maintenance"
	},
	"featured": [
		"[lit-translate](https://github.com/andreasbm/lit-translate)",
		"[masonry-layout](https://github.com/andreasbm/masonry-layout)",
		"[focus-trap](https://github.com/andreasbm/focus-trap)",
		"[web-router](https://github.com/andreasbm/web-router)",
		"[web-config](https://github.com/andreasbm/web-config)",
		"[ts-lit-plugin](https://github.com/runem/ts-lit-plugin)",
		"[blob](https://github.com/andreasbm/blob)"
	],
	"templates": [
		{
			"name": "install",
			"template": "Run `npm install [[ ids.npm ]]' to install this library!"
		}
	],
	"example": {
		"command": "node_modules/.bin/readme generate"
	},
	"properties": [
		[
			"Attribute",
			"Type",
			"Description"
		],
		[
			"**size**",
			"'medium', 'large'",
			"Determines the size"
		],
		[
			"**active**",
			"boolean",
			"Whether the element is active or not"
		]
	],
	"commandOptions": [
		[
			"Option",
			"Type",
			"Description"
		],
		[
			"-c, --config",
			"string",
			"Path of the configuration file. Defaults to 'blueprint.json"
		],
		[
			"-p, --package",
			"string",
			"Path of the 'package.json' file. Defaults to 'package.json'."
		],
		[
			"--pkg.name",
			"string",
			"Name of the project. Used for the 'title' template."
		],
		[
			"--pkg.contributors",
			"{name: string; email: string; url: string; img: string; info: string[];}[]",
			"Contributors of the project. Used for the 'contributors' template."
		],
		[
			"--pkg.license",
			"string",
			"License kind. Used for the 'license' template."
		],
		[
			"-o, --output",
			"string",
			"Path of the generated README file. Defaults to 'README.md'."
		],
		[
			"-h, --help",
			"",
			"Display this help message."
		],
		[
			"-i, --input",
			"string",
			"The blueprint. Defaults to 'blueprint.md'."
		],
		[
			"--badges",
			"{alt: string, url: string, img: string}[]",
			"Badges. Used for the 'badges' template."
		],
		[
			"--text",
			"string",
			"Text describing your project. Used for the 'description' template."
		],
		[
			"--demo",
			"string",
			"Demo url for your project. Used for the 'description' template."
		],
		[
			"--lineBreak",
			"string",
			"The linebreak used in the generation of the README file. Defaults to 'rn'"
		],
		[
			"--tab",
			"string",
			"The tab used in the generation of the README file. Defaults to 't'"
		],
		[
			"--placeholder",
			"[string, string]",
			"The placeholder syntax used when looking for templates in the blueprint. Defaults to '[\"{{\", \"}}\"]."
		],
		[
			"--line",
			"string",
			"The line style of the titles. Can also be an URL. Defaults to 'colored'."
		],
		[
			"--templates",
			"{name: string, template: string}[]",
			"User created templates."
		],
		[
			"-s, --silent",
			"boolean",
			"Whether the console output from the command should be silent."
		],
		[
			"-d, --dry",
			"boolean",
			"Whether the command should run as dry. If dry, the output file is notgenerated but outputted to the console instead."
		],
		[
			"--headingPrefix",
			"{[key: number]: string}",
			"The prefix of the header tags. Defaults to '{1: \"➤ \", 2: \"➤ \"}'"
		],
		[
			"--logo",
			"{src: string; alt?: string; width?: number; height?: number;}",
			"The logo information. Used for the 'logo' template."
		],
		[
			"--contributorsPerRow",
			"number",
			"The amount of contributors pr row when using the 'contributors' template. Defaults to '6'"
		],
		[
			"--documentationConfig",
			"object",
			"Configuration object for automatic documentation template."
		],
		[
			"--extend",
			"string",
			"Path to another configuration object that should be extended."
		],
		[
			"--checkLinks",
			"boolean",
			"Checks all links for aliveness after the README file has been generated."
		]
	]
}