{"id":15064108,"url":"https://github.com/esoltys/repo-documenter","last_synced_at":"2025-04-10T11:50:35.096Z","repository":{"id":251526156,"uuid":"837652986","full_name":"esoltys/Repo-Documenter","owner":"esoltys","description":"Repo-Documenter is a PowerShell script that generates comprehensive documentation for a repository, including a tree view of the repository structure and the contents of specified files. The aggregated file is useful for code review, documentation, or use by an AI assistant.","archived":false,"fork":false,"pushed_at":"2024-08-05T16:53:39.000Z","size":122,"stargazers_count":4,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-24T10:38:52.091Z","etag":null,"topics":["code-assistant","powershell"],"latest_commit_sha":null,"homepage":"","language":"PowerShell","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/esoltys.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-08-03T15:57:54.000Z","updated_at":"2025-03-16T08:43:09.000Z","dependencies_parsed_at":"2024-08-05T19:26:16.882Z","dependency_job_id":null,"html_url":"https://github.com/esoltys/Repo-Documenter","commit_stats":null,"previous_names":["esoltys/repo-documenter"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/esoltys%2FRepo-Documenter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/esoltys%2FRepo-Documenter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/esoltys%2FRepo-Documenter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/esoltys%2FRepo-Documenter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/esoltys","download_url":"https://codeload.github.com/esoltys/Repo-Documenter/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248215192,"owners_count":21066619,"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":["code-assistant","powershell"],"created_at":"2024-09-25T00:11:32.923Z","updated_at":"2025-04-10T11:50:35.075Z","avatar_url":"https://github.com/esoltys.png","language":"PowerShell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Repo-Documenter\n\nRepo-Documenter is a PowerShell script that generates comprehensive documentation for a repository, including a tree view of the repository structure and the contents of specified files. The aggregated file is useful for code review, documentation, or use by an AI assistant.\n\n![screenshot](screenshot.png)\n\n## Features\n\n- Generates a tree view of the repository structure\n- Aggregates content from specified files\n- Safely handles binary files by excluding their content\n- Outputs a single Markdown file containing the repository documentation\n- Configurable via a simple configuration file\n\n## Prerequisites\n\n- PowerShell 5.1 or later\n\n## Installation\n\n1. Clone this repository or download the `Repo-Documenter.ps1` script.\n2. Ensure that PowerShell execution policy allows running scripts.\n\n## Usage\n\n1. Create a `repo_documenter.config` file in the root of the repository you want to document.\n2. Add patterns to the `repo_documenter.config` file to specify which files and directories to include.\n3. Run the script with the following command:\n\n```powershell\n.\\Repo-Documenter.ps1 -RepoPath \u003cpath_to_your_repository\u003e [-OutputFile \u003coutput_file_name\u003e]\n```\n\nIf no output file is specified, the script will create a Markdown file named after the repository in the current directory.\n\n## Configuration\n\nCreate a `repo_documenter.config` file in the root of your repository. Each line in this file should contain a pattern for files or directories to include. For example:\n\n```\n*.md\nsrc/*\ndocs/*.txt\n```\n\nThis configuration will include all Markdown files, everything in the `src` directory, and all text files in the `docs` directory.\n\n## Binary File Handling\n\nThe script now safely handles binary files:\n- Binary files (e.g., images, executables) are detected automatically.\n- Content of binary files is not included in the output to prevent corruption.\n- Binary files are listed in the repository structure but marked as binary in the file contents section.\n\n## Output\n\nThe script generates a Markdown file containing:\n\n1. A tree view of the repository structure (based on the configuration)\n2. The contents of all included text files\n3. Placeholders for binary files\n\n## License\n\n[MIT License](LICENSE)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fesoltys%2Frepo-documenter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fesoltys%2Frepo-documenter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fesoltys%2Frepo-documenter/lists"}