Skip to content

instructions-d-installation/web-installation-instruction

Repository files navigation

web-installation-instruction

Tool rendering html page from install.cfg file.

PyPI - Version PyPI - License

Usage

  1. Create an install.cfg which adheres to installation-instruction.
  2. Compile the install.cfg to an html file with ibi-build-html.
 Usage: ibi-build-html [OPTIONS]

╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ --input   -i      TEXT  Path to config file. [default: ./install.cfg]                                                                                                                                                        │
│ --output  -o      TEXT  Path to output directory. [default: ./public]                                                                                                                                                        │
│ --help                  Show this message and exit.                                                                                                                                                                          │
╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯

Github Action

Take a look at web-installation-instruction-action.

Automatic Defaults

You must have such property in your schema and have some of the options below (take those that you actually support):

__os__:
  - android
  - ios
  - windows
  - linux
  - macos
  - openbsd
  - freebsd

Example

example