maintenance-page-generator
Simple maintenance page generator cli
Installation
npm i -g maintenance-page-generator
You can now use maintenance-page-generator
command or mpg
alias command.
Usage
$ npm install -g maintenance-page-generator
$ maintenance-page-generator COMMAND
running command...
$ maintenance-page-generator (-v|--version|version)
maintenance-page-generator/1.2.0 linux-x64 node-v14.15.4
$ maintenance-page-generator --help [COMMAND]
USAGE
$ maintenance-page-generator COMMAND
...
Commands
maintenance-page-generator build [FOLDER]
maintenance-page-generator docker [FOLDER]
maintenance-page-generator help [COMMAND]
maintenance-page-generator preview [FOLDER]
maintenance-page-generator build [FOLDER]
build an html maintenance page
USAGE
$ maintenance-page-generator build [FOLDER]
ARGUMENTS
FOLDER [default: ./] Configuration folder
OPTIONS
-f, --file=file Destination html file name
-h, --help show CLI help
EXAMPLE
$ mpg build
See code: src/commands/build.ts
maintenance-page-generator docker [FOLDER]
build a maintenance docker image
USAGE
$ maintenance-page-generator docker [FOLDER]
ARGUMENTS
FOLDER [default: ./] Configuration folder
OPTIONS
-h, --help show CLI help
-t, --tagName=tagName Docker image tag name
EXAMPLE
$ mpg docker
See code: src/commands/docker.ts
maintenance-page-generator help [COMMAND]
display help for maintenance-page-generator
USAGE
$ maintenance-page-generator help [COMMAND]
ARGUMENTS
COMMAND command to show help for
OPTIONS
--all see all commands in CLI
See code: @oclif/plugin-help
maintenance-page-generator preview [FOLDER]
preview maintenance page in browser
USAGE
$ maintenance-page-generator preview [FOLDER]
ARGUMENTS
FOLDER [default: ./] Configuration folder
OPTIONS
-h, --help show CLI help
-l, --livereload=livereload [default: 35729] Livereload server port
-p, --port=port [default: 8080] Server port
EXAMPLE
$ mpg preview
See code: src/commands/preview.ts
Configuration
Configuration file
To customize your maintenance page, you can create a mpg.config.json file with some options.
{
"title": "We'll be back soon !",
"description": "Sorry for the inconvenience but we’re performing some maintenance at the moment.",
"meta": {
"title": "Maintenance page",
"description": null
}
}
All fields are optionals.
Add images
You can add images to your directory
- logo.{svg,png,jpg,jpeg}
- background.{svg,png,jpg,jpeg}
- favicon.ico (only for docker build)
Customize style
You can add a stylesheet : style.css
.
Css selectors :
- .container
- .content
- .logo
- .title
- .text
Customize html head
You can add a head.html
file with your custom head tags.
Example :
<link href="https://fonts.googleapis.com/css?family=Montserrat:300,400,500,600,700" rel="stylesheet" />