{"id":32118722,"url":"https://github.com/jukefr/readme-manager","last_synced_at":"2026-02-21T19:34:01.270Z","repository":{"id":41443544,"uuid":"509581642","full_name":"jukefr/readme-manager","owner":"jukefr","description":"helps manage and harmonise READMEs in many repositories with template files","archived":false,"fork":false,"pushed_at":"2022-07-04T10:57:24.000Z","size":119,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-10-01T02:28:24.797Z","etag":null,"topics":["deno","manager","readme","template"],"latest_commit_sha":null,"homepage":"https://deno.land/x/readme_manager","language":"TypeScript","has_issues":false,"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/jukefr.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.CNPLv7+.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-07-01T20:30:42.000Z","updated_at":"2024-03-09T20:32:00.000Z","dependencies_parsed_at":"2022-09-21T09:10:59.234Z","dependency_job_id":null,"html_url":"https://github.com/jukefr/readme-manager","commit_stats":null,"previous_names":[],"tags_count":26,"template":false,"template_full_name":null,"purl":"pkg:github/jukefr/readme-manager","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jukefr%2Freadme-manager","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jukefr%2Freadme-manager/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jukefr%2Freadme-manager/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jukefr%2Freadme-manager/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jukefr","download_url":"https://codeload.github.com/jukefr/readme-manager/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jukefr%2Freadme-manager/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29691045,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-21T18:18:25.093Z","status":"ssl_error","status_checked_at":"2026-02-21T18:18:22.435Z","response_time":107,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["deno","manager","readme","template"],"created_at":"2025-10-20T17:34:05.942Z","updated_at":"2026-02-21T19:34:01.264Z","avatar_url":"https://github.com/jukefr.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# [readme-manager](https://code.eutychia.org/kay/readme-manager)\nhelps manage and harmonise READMEs in many repositories with template files available on [deno.land/x/readme_manager](https://deno.land/x/readme_manager)\n\nDefine a template directory and write a README template for your\nproject then compile it into a proper README.\n\n## Installation\n```bash\n$ deno install --name readme-manager --reload --allow-all https://deno.land/x/readme_manager/cli.ts\n```\n\n## Usage\nOn the first run without any arguments a setup will happen :\n - `match` corresponds to the name the README template will have inside the repository\nit is created on first start but you can always recreate it with `--setup`\n(default `.README.template.md`)\n - `templates` corresponds to the path where the rendering function is stored\nit is boostrapped on first start but you can always access it with `--bootstrap`\n(default `$USER_CONFIG_DIR/readme-manager`)\n\n```bash\n$ readme-manager\n# Will guide you through setup on first run\n\n$ readme-manager\n# Will create readme in current directory with template and config\n\n$ readme-manager my-project\n# Will create readme in my-project directory with template and config\n\n$ readme-manager [...] --templates [path]\n# Will create a readme with config match and overriden template directory\n\n$ readme-manager [...] --match [name]\n# Will create a readme with config template directory and overriden match name\n\n$ readme-manager [...] --templates [path] --match [name]\n# Will create a readme and bypass configuration (if it exists)\n```\n\nThere are also some other commands :\n```bash\n$ readme-manager --help\n# Will print the help page\n\n$ readme-manager --setup\n# Re-run setup step and backup old config\n\n$ readme-manager --bootstrap\n# Re-run templates boostrapping step and backup old directory\n```\n\nThere is also a debug flag available that can be added to any command :\n```bash\n$ readme-manager [...] --debug\n# Will print more information to console and save all logs to the log file (instead of only errors by default)\n```\n\n## Example\nYou can check out the current templates I use for my project (including this readme) [over here](https://code.eutychia.org/kay/readme-templates).\n\n## Templating\nWhen you bootstrap the templates forlder, 3 examples files will be create for you :\n- README.template.md: this is the base file that gets used when rendering your readme. You can await stuff in it. **This is the only required file**\n- HEADER.template.md: is an example header you might use\n- FOOTER.template.md: is an example footer you might use\n\nFeel free to adjust, remove or add any files you might want. Simply keep in mind that `README.template.md` is required and will be the base for rendering.\n\nAny file in the templates folder will be automatically required and available by its filename with `await include(filename)`.\n\nAny file that starts with `.` will be ignored.\n\n## Template variables\nThe following variables are available to the template (on `it`):\n- name: basename of the folder the README is in\n- readme: content of the readme template file\n- readmeFilePath: the absolute filepath of the readme\n- readmeDirectoryPath: the absolute path of the directory containing the readme\n- gitTag: the current git tag\n- gitURL: the repository url\n- gitCommit: the sha of the current commit\n- gitBranch: the current checkout out branch\n\nYou can use javascript inside the templates and also async templates for data fetching (see Eta docs)\n\n**Make sure to `await` any includes you do !** As templates are compiled in async mode for await support (even if you are not using it).\n\n## Templating docs\nThe templating engine use is https://deno.land/x/eta@v1.12.3.\n\nMore information about it can be found on their documentation.\n\n## Suggestion\nIf you are going to be using this for many repositories you might want tot setup a git template folder and add a precommit hook that runs the `readme-manager`.\n\nHere is what mine looks like:\n```bash\n# ~/.git-templates/hooks/pre-commit\n# git config --global init.templatedir '~/.git-templates'\n# git init \n\n#!/usr/bin/env bash\n~/.deno/bin/readme-manager\ngit add -u\n```\n\n## Documentation\nDocumentation view is currently disabled for third party modules on deno.land/x but you can still view the auto generated docs on [doc.deno.land](https://doc.deno.land/https://deno.land/x/readme_manager)\n\n\n\n## Development\n\nTo clone the repository locally:\n\n```bash\n$ git clone https://code.eutychia.org/kay/readme-manager.git\n```\n\n## Contributing\n\nSee [this page](https://code.eutychia.org/kay/contributing/-/blob/main/README.md) for more information on contributing to this project.\n\n### Issues\nOpen new issues by mailing [eutychia.gitlab+kay-readme-manager-67-issue-@gmail.com](mailto:eutychia.gitlab+kay-readme-manager-67-issue-@gmail.com)\n\n---\nbeep boop\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjukefr%2Freadme-manager","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjukefr%2Freadme-manager","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjukefr%2Freadme-manager/lists"}