https://github.com/dargstack/dargstack_rgen
Generates a DargStack stack project readme.
https://github.com/dargstack/dargstack_rgen
generator markdown yaml
Last synced: 9 days ago
JSON representation
Generates a DargStack stack project readme.
- Host: GitHub
- URL: https://github.com/dargstack/dargstack_rgen
- Owner: dargstack
- Created: 2020-06-07T23:02:57.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2025-07-09T07:45:46.000Z (7 months ago)
- Last Synced: 2025-07-09T08:57:31.767Z (7 months ago)
- Topics: generator, markdown, yaml
- Language: JavaScript
- Homepage: https://github.com/dargmuesli/dargstack
- Size: 2.31 MB
- Stars: 1
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
README
[](https://github.com/dargstack/dargstack_rgen/actions/workflows/ci.yml)
# DargStack RGen
[DargStack](https://github.com/dargstack/dargstack)'s README.md generator.
Run the script using `node ./src/generator.js` or [`dargstack rgen`](https://github.com/dargstack/dargstack).
## Help
```
Options:
--version Show version number [boolean]
--path, -p Path to a DargStack stack project [string]
--help, -h Show help [boolean]
```
## Example
YAML input:
```yaml
# example.com
# https://example.com/
# example
# https://github.com/example/example/
---
configs:
service_config:
# The service's config.
file: ./path/to/con.fig
secrets:
service_password:
# The service's login password
file: ./path/to/password.secret
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/).
configs:
- source: service_config
target: /src/app/config/con.fig
image: service:1.2.3
secrets:
- service_password
volumes:
- service_data:/mnt/data/
version: "3.8"
volumes:
service_data:
# The service's data.
{}
```
Markdown output:
```markdown
# 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 Contents
1. [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](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 Contents
>
>
>1. [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.
>
>