{"id":29493400,"url":"https://github.com/dargstack/dargstack_rgen","last_synced_at":"2026-03-03T03:12:32.261Z","repository":{"id":40302288,"uuid":"270456697","full_name":"dargstack/dargstack_rgen","owner":"dargstack","description":"Generates a DargStack stack project readme.","archived":false,"fork":false,"pushed_at":"2025-07-09T07:45:46.000Z","size":2424,"stargazers_count":1,"open_issues_count":0,"forks_count":2,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-07-09T08:57:31.767Z","etag":null,"topics":["generator","markdown","yaml"],"latest_commit_sha":null,"homepage":"https://github.com/dargmuesli/dargstack","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dargstack.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"github":["dargmuesli"],"patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":null}},"created_at":"2020-06-07T23:02:57.000Z","updated_at":"2025-07-09T07:45:49.000Z","dependencies_parsed_at":"2022-07-09T05:46:27.990Z","dependency_job_id":"faf40f27-57bb-443a-9a99-7cfc80c13e44","html_url":"https://github.com/dargstack/dargstack_rgen","commit_stats":{"total_commits":1195,"total_committers":7,"mean_commits":"170.71428571428572","dds":0.5824267782426777,"last_synced_commit":"f28ebe0f5e77961f8baec7967c3b7b7b83ebf284"},"previous_names":["dargmuesli/dargstack_rgen"],"tags_count":162,"template":false,"template_full_name":null,"purl":"pkg:github/dargstack/dargstack_rgen","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dargstack%2Fdargstack_rgen","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dargstack%2Fdargstack_rgen/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dargstack%2Fdargstack_rgen/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dargstack%2Fdargstack_rgen/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dargstack","download_url":"https://codeload.github.com/dargstack/dargstack_rgen/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dargstack%2Fdargstack_rgen/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265395580,"owners_count":23758036,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["generator","markdown","yaml"],"created_at":"2025-07-15T16:12:31.008Z","updated_at":"2026-01-16T04:55:41.890Z","avatar_url":"https://github.com/dargstack.png","language":"JavaScript","readme":"[![CI](https://github.com/dargstack/dargstack_rgen/actions/workflows/ci.yml/badge.svg)](https://github.com/dargstack/dargstack_rgen/actions/workflows/ci.yml)\n\n# DargStack RGen\n\n[DargStack](https://github.com/dargstack/dargstack)'s README.md generator.\n\nRun the script using `node ./src/generator.js` or [`dargstack rgen`](https://github.com/dargstack/dargstack).\n\n## Help\n\n```\nOptions:\n  --version   Show version number                                      [boolean]\n  --path, -p  Path to a DargStack stack project                         [string]\n  --help, -h  Show help                                                [boolean]\n```\n\n## Example\n\nYAML input:\n\n```yaml\n# example.com\n# https://example.com/\n# example\n# https://github.com/example/example/\n---\nconfigs:\n  service_config:\n  # The service's config.\n    file: ./path/to/con.fig\nsecrets:\n  service_password:\n  # The service's login password\n    file: ./path/to/password.secret\nservices:\n  adminer:\n  # You can access the service's frontend at [service.app.localhost](https://service.app.localhost/).\n  # This information is required for login:\n  #\n  # |          |                     |\n  # | -------- | ------------------- |\n  # | Username | service_user     |\n  # | Password | [service_password] |\n  #\n  # Values in square brackets are [Docker secrets](https://docs.docker.com/engine/swarm/secrets/).\n    configs:\n    - source: service_config\n      target: /src/app/config/con.fig\n    image: service:1.2.3\n    secrets:\n    - service_password\n    volumes:\n    - service_data:/mnt/data/\nversion: \"3.8\"\nvolumes:\n  service_data:\n  # The service's data.\n    {}\n```\n\nMarkdown output:\n\n```markdown\n# example_stack\n\n\nThe Docker stack configuration for [example.com](https://example.com/).\n\nThis 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/).\n\n## Table of Contents\n\n\n 1. [configs](#configs)\n\n 2. [secrets](#secrets)\n\n 3. [services](#services)\n\n 4. [volumes](#volumes)\n\n\n## configs\n\n\n - ### `service_config`\n\n    The service's config.\n\n\n## secrets\n\n\n - ### `service_password`\n\n    The service's login password\n\n\n## services\n\n\n - ### `adminer`\n\n    You can access the service's frontend at [service.app.localhost](https://service.app.localhost/).\n    This information is required for login:\n\n    |          |                     |\n    | -------- | ------------------- |\n    | Username | service_user     |\n    | Password | [service_password] |\n\n    Values in square brackets are [Docker secrets](https://docs.docker.com/engine/swarm/secrets/).\n\n\n## volumes\n\n\n - ### `service_data`\n\n    The service's data.\n\n\n\n```\n\nMarkdown rendered:\n\n\u003e # example_stack\n\u003e The Docker stack configuration for [example.com](https://example.com/).\n\u003e\n\u003eThis 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/).\n\u003e\n\u003e## Table of Contents\n\u003e\n\u003e\n\u003e1. [configs](#configs)\n\u003e\n\u003e2. [secrets](#secrets)\n\u003e\n\u003e3. [services](#services)\n\u003e\n\u003e4. [volumes](#volumes)\n\u003e\n\u003e\n\u003e## configs\n\u003e\n\u003e\n\u003e- ### `service_config`\n\u003e\n\u003e    The service's config.\n\u003e\n\u003e\n\u003e## secrets\n\u003e\n\u003e\n\u003e- ### `service_password`\n\u003e\n\u003e    The service's login password\n\u003e\n\u003e\n\u003e## services\n\u003e\n\u003e\n\u003e- ### `adminer`\n\u003e\n\u003e    You can access the service's frontend at [service.app.localhost]\u003e(https://service.app.localhost/).\n\u003e    This information is required for login:\n\u003e\n\u003e    |          |                     |\n\u003e    | -------- | ------------------- |\n\u003e    | Username | service_user     |\n\u003e    | Password | [service_password] |\n\u003e\n\u003e    Values in square brackets are [Docker secrets](https://docs.docker.\u003ecom/engine/swarm/secrets/).\n\u003e\n\u003e\n\u003e## volumes\n\u003e\n\u003e\n\u003e- ### `service_data`\n\u003e\n\u003e    The service's data.\n\u003e\n\u003e\n","funding_links":["https://github.com/sponsors/dargmuesli"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdargstack%2Fdargstack_rgen","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdargstack%2Fdargstack_rgen","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdargstack%2Fdargstack_rgen/lists"}