README.md

metadata

title: Repo to Markdown Converter
emoji: 📄
colorFrom: blue
colorTo: green
sdk: gradio
sdk_version: 5.24.0
app_file: app.py
pinned: false
license: mit

Repo to Markdown Converter

This Hugging Face Space converts a Git repository (from a URL) or an uploaded local folder (as a .zip archive) into a single Markdown file.

Features:

• Supports public Git repository URLs.
• Supports uploading local project folders (packaged as .zip).
• Generates a directory structure overview.
• Includes the content of text/code files within fenced code blocks.
• Attempts syntax highlighting using file extensions.
• Allows customizing file/directory ignore patterns.
• Option to set a maximum file size for content inclusion.
• Provides the generated Markdown for viewing and download.

How to Use:

1. Select the Input Source: "URL" or "Upload ZIP".
2. If URL: Enter the full HTTPS URL of the public Git repository.
3. If Upload ZIP: Click or drag-and-drop your .zip file containing the project folder.
4. (Optional) Modify the Ignore Patterns (comma-separated). Sensible defaults are provided. Add / at the end for directory patterns (e.g., node_modules/).
5. (Optional) Adjust the Max File Size limit (in KB). Files larger than this will be listed, but their content won't be included in the Markdown.
6. Click Generate Markdown.
7. The generated Markdown will appear in the output panel.
8. A Download .md File button will appear once generation is complete.

Limitations:

• Only works with publicly accessible Git repositories (no authentication).
• Large repositories or files might take time or exceed resource limits.
• Binary file detection is basic; some binary files might be misidentified as text, or vice-versa.
• ZIP extraction assumes a standard structure; deeply nested or unusually structured ZIPs might not process correctly.