git2md 1.1.3

Convert Git repository contents to Markdown format.

git2md

A powerful command-line tool for converting Git repository contents into Markdown format. This tool is ideal for developers and documentation specialists who need to generate structured Markdown files from Git repositories, including directory trees and file contents.

---

Features

• Generate repository directory tree: Outputs the structure of the repository in a tree block format.
• Convert files to Markdown:
  • Supports syntax highlighting for code files.
  • Converts Jupyter Notebooks (.ipynb) and PDFs (.pdf) into Markdown.
• Support for .gitignore and .globalignore:
  • Automatically excludes files/directories listed in .gitignore or .globalignore.
• Custom exclusion patterns: Use regular expressions to exclude specific files or directories.
• Skip empty files: Avoids processing files with no content.
• Copy output to clipboard: Easily copy the generated Markdown output for further use.
• Multithreading support: Speeds up file processing for large repositories.

---

Demonstration

Add a demonstration GIF here to showcase how the tool works.

---

Requirements

• Python 3.12 or higher
• Linux operating system
• Dependencies:
  • pathspec (for .gitignore support)
  • nbconvert (for Jupyter Notebook conversion)
  • PyMuPDF4LLM (for PDF conversion)
  • wl-copy (optional, for clipboard functionality)

---

Installation

Install from PyPI

You can install git2md directly from PyPI using pip:

pip install git2md

Install from AUR (Arch Linux)

For Arch Linux users, the package is available in the AUR as git2md-git. You can install it using an AUR helper like paru or yay:

paru -S git2md-git

Install from source

1. Clone the repository:

   git clone https://github.com/xpos587/git2md.git
   cd git2md
   

2. Build and install:

   python setup.py build
   pip install .
   

---

Usage

Basic Command

git2md [path] [options]

Если путь не указан, будет использована текущая директория.

Options

Option	Description
path	Path to the Git project directory or file (default: current directory)
-o, --output	Output file path for saving the generated Markdown
-gexc, --glob-exclude	List of glob patterns for excluding files or directories
-se, --skip-empty-files	Skip empty files during processing
-cp, --clipboard	Copy the output content to clipboard (requires wl-copy)
-igi, --ignore-gitignore	Ignore .gitignore and .globalignore rules

---

Examples

Generate Markdown for an entire repository

git2md /path/to/repo -o output.md

Exclude specific files using glob patterns

git2md -gexc "*.log" "*.tmp" -o output.md

Skip empty files and copy output to clipboard

git2md -se -cp

Ignore .gitignore rules

git2md -igi -o output.md

---

Output Format

Directory Tree

The directory tree is included as a code block with the language identifier tree. For example:

src/
├── main.py
├── utils/
│   ├── helper.py
│   └── __init__.py
└── README.md

File Contents

Each file is included with its relative path as a header, followed by its content in a code block.

Example for a Python File (main.py)

# File: src/main.py

```python
print("Hello, world!")
```

# End of file: src/main.py

Example for a Jupyter Notebook (notebook.ipynb)

The content is converted from .ipynb to Markdown and included directly:

# File: notebook.ipynb

# Converted content from Jupyter Notebook...

# End of file: notebook.ipynb

Example for a PDF (document.pdf)

The content is extracted as Markdown:

# File: document.pdf

# Extracted content from PDF...

# End of file: document.pdf

---

Global Ignore Patterns

You can create a .globalignore file in the same directory as the script to specify patterns that should be ignored across all repositories. The format is identical to .gitignore.

Example .globalignore

__pycache__/
*.pyc
.mypy_cache/
.env
*.log

---

Development

To set up the development environment:

1. Create a virtual environment:

   python -m venv .venv
   source .venv/bin/activate
   

2. Install dependencies:

   pip install pathspec nbconvert pymupdf4llm
   

3. Install in editable mode:

   pip install -e .
   

---

License

This project is licensed under the MIT License - see the LICENSE file for details.

---

Contributing

1. Fork the repository.
2. Create your feature branch (git checkout -b feature/amazing-feature).
3. Commit your changes (git commit -m 'Add some amazing feature').
4. Push to the branch (git push origin feature/amazing-feature).
5. Open a Pull Request.

---

Authors

Michael ([e-mail])

---

Acknowledgments

Thanks to the developers of the pathspec, nbconvert, and PyMuPDF4LLM libraries.

Inspired by the need to easily document Git repositories for LLM-based workflows.