DargStack RGen

DargStack's README.md generator.

Run the script using node ./src/generator.js or dargstack rgen.

Help

Options:
--version Show version number [boolean]
--path, -p Path to a DargStack stack project [string]
--help, -h Show help [boolean]

Example

YAML input:

# example.com# https://example.com/# example# https://github.com/example/example/
---
configs:
service_config:
# The service's config.file: ./path/to/con.figsecrets:
service_password:
# The service's login passwordfile: ./path/to/password.secretservices:
adminer:
# You can access the service's frontend at [service.app.localhost](https://service.app.localhost/).# This information is required for login:## | | |# | -------- | ------------------- |# | Username | service_user |# | Password | [service_password] |## Values in square brackets are [Docker secrets](https://docs.docker.com/engine/swarm/secrets/).configs:
- source: service_configtarget: /src/app/config/con.figimage: service:1.2.3secrets:
- service_passwordvolumes:
- service_data:/mnt/data/version: "3.8"volumes:
service_data:
# The service's data.{}

Markdown output:

# example_stack
The Docker stack configuration for [example.com](https://example.com/).
This project is deployed in accordance to the [DargStack template](https://github.com/dargstack/dargstack_template/) to make deployment a breeze. It is closely related to [example's source code](https://github.com/example/example/).
## Table of Contents1.[configs](#configs)2.[secrets](#secrets)3.[services](#services)4.[volumes](#volumes)## configs-### `service_config`
The service's config.
## secrets-### `service_password`
The service's login password
## services-### `adminer`
You can access the service's frontend at [service.app.localhost](https://service.app.localhost/).
This information is required for login:
|||| -------- | ------------------- || Username | service_user || Password |[service_password]|
Values in square brackets are [Docker secrets](https://docs.docker.com/engine/swarm/secrets/).
## volumes-### `service_data`
The service's data.

Markdown rendered:

example_stack

The Docker stack configuration for example.com.

This project is deployed in accordance to the DargStack template to make deployment a breeze. It is closely related to example's source code.

Table of Contents

1. configs

2. secrets

3. services

4. volumes

configs

• service_config

  The service's config.

secrets

• service_password

  The service's login password

services

• adminer

  You can access the service's frontend at [service.app.localhost]>(https://service.app.localhost/). This information is required for login:

  Username	service_user
  Password	[service_password]

  Values in square brackets are Docker secrets.

volumes

• service_data

  The service's data.