god-tier-metadata v0.1.0

god-tier-metadata

A CLI for generating high-quality web metadata and icons.

Creating metadata and icons for your website can be confusing and sometimes even overwhelming. What <meta> tags do I need to include? What types of icons should I generate? What about a web manifest? What about Open Graph, site maps, or structured data?

god-tier-metadata makes this easy for you by generating all the metadata and icons you need from a single configuration file. This eliminates the need to read and understand multiple specifications for metadata formats, and makes it easy to generate different icons for different devices.

Disclaimer

This project is in early development and is not intended for production usage at this time.

Usage

Pre-requisites: Node.js, npm

# Globally install the package
npm install -g god-tier-metadata

# Generate metadata and icons
god-tier-metadata configFile.json outputFolder

Configuration

god-tier-metadata takes a configuration file which it uses to generate metadata. The configuration file has the following structure:

{
	"site": {
		"domain": "example.com",
		"name": "Example site"
	},
	"pages": [
		{
			"url": "/about",
			"name": "About"
		}
	]
}

Site options

site.domain string

The domain name of the site, e.g., example.com or www.w3.org.

site.name string

The name of the site.

Page options

page.url string

The relative URL of the page, e.g., /about or /.

page.name string

The name of the page.

Development

god-tier-metadata should be edited in Visual Studio Code using the Prettier and ESLint plugins. All code must be formatted on save using Prettier and must pass ESLint validation.

# Install dependencies
yarn install

# Build only
yarn build

# Build and generate the test project
yarn test

# Lint with ESLint
yarn lint

License

god-tier-metadata is developed by Julian Lachniet and released under the MIT License. For more information, please see the LICENSE file.