{"id":19259055,"url":"https://github.com/r3drun3/runnable-readme","last_synced_at":"2025-09-10T21:31:51.261Z","repository":{"id":65661846,"uuid":"595497304","full_name":"R3DRUN3/runnable-readme","owner":"R3DRUN3","description":"Make your readme executable! 📖 ⚙️","archived":true,"fork":false,"pushed_at":"2023-02-01T08:07:18.000Z","size":2650,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-21T10:03:11.965Z","etag":null,"topics":["bash","documentation","readme"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/R3DRUN3.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2023-01-31T07:45:48.000Z","updated_at":"2025-02-14T13:48:06.000Z","dependencies_parsed_at":"2023-02-17T03:15:35.422Z","dependency_job_id":null,"html_url":"https://github.com/R3DRUN3/runnable-readme","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/R3DRUN3/runnable-readme","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/R3DRUN3%2Frunnable-readme","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/R3DRUN3%2Frunnable-readme/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/R3DRUN3%2Frunnable-readme/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/R3DRUN3%2Frunnable-readme/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/R3DRUN3","download_url":"https://codeload.github.com/R3DRUN3/runnable-readme/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/R3DRUN3%2Frunnable-readme/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":274528013,"owners_count":25302320,"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","status":"online","status_checked_at":"2025-09-10T02:00:12.551Z","response_time":83,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["bash","documentation","readme"],"created_at":"2024-11-09T19:15:19.231Z","updated_at":"2025-09-10T21:31:50.426Z","avatar_url":"https://github.com/R3DRUN3.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# RUNNABLE README\n[![release](https://github.com/R3DRUN3/runnable-readme/actions/workflows/release.yaml/badge.svg)](https://github.com/R3DRUN3/runnable-readme/actions/workflows/release.yaml)\n[![Go Report Card](https://goreportcard.com/badge/github.com/R3DRUN3/runnable-readme)](https://goreportcard.com/report/github.com/R3DRUN3/runnable-readme)\n[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)\n\u003cbr/\u003e\n\n\u003cimg src=\"images/gopher.png\" width=\"350\" height=\"350\"\u003e\n\n\u003cbr/\u003e\nMake your readme executable! 📖 ⚙️\n\n\u003cbr/\u003e\n\n## Abstract\n*Runnable Readme* is a simple utility that allows people to execute bash commands that are found in *README* (markdown) files in automatic fashion.\n\u003cbr/\u003e\nThe advantage is twofold:\n1. Allow those who follow a documentation to avoid tedious copy-paste.\n2. Encourage developers to write documentation that is as clear and reproducible as possible.\n\nWe can call this *Documentation as Code* 😊\n\n## Instructions\nDownload this utility from the release or clone this repo and launch it locally (it requires go v1.19).\n\u003cbr/\u003e\nexample, clone the repo:  \n```console\ngit clone https://github.com/r3drun3/runnable-readme.git \u0026\u0026 cd runnable-readme\n```\n\n\u003cbr/\u003e\n\ntest it against a *markdown* file:  \n```console\ngo run main.go exec examples/example.md\n```\n\n\u003cbr/\u003e\n\nOutput:  \n```console\nExecuting command number  1\nOutput: Hello World!\n\nExecuting command number  2\nOutput: My external IP is: 97.0.21.159\nSleeping for 3 seconds\nGoodbye!\n\nExecuting command number  3\nOutput: where am I?\n/tmp\nlet's create folders in loop\nSleeping for 2 seconds\nremoving the folders\nOperation OK: true\n```\n\n\u003cbr/\u003e\n\n\n\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fr3drun3%2Frunnable-readme","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fr3drun3%2Frunnable-readme","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fr3drun3%2Frunnable-readme/lists"}