> ## Documentation Index
> Fetch the complete documentation index at: https://mintlify.com/BankkRoll/repo2pdf/llms.txt
> Use this file to discover all available pages before exploring further.

# Introduction to repo2pdf

> Transform GitHub repositories into beautifully formatted PDF documents with syntax highlighting and customization options

## Welcome to repo2pdf

repo2pdf is an innovative CLI tool designed to seamlessly transform GitHub repositories into well-formatted, visually engaging, and easy-to-navigate PDF files. By automating the process of cloning repositories and parsing code files, repo2pdf serves a variety of use-cases including teaching, code reviews, offline referencing, archiving, AI training, and document embedding.

The tool bridges the gap between the dynamic world of coding and the static, universally accessible format of PDFs, catering to a multitude of user needs and creative applications.

## Key features

<CardGroup cols={2}>
  <Card title="Syntax highlighting" icon="highlighter">
    Beautiful code highlighting powered by highlight.js with support for 100+ languages
  </Card>

  <Card title="Flexible input" icon="folder-tree">
    Convert GitHub repositories or local directories to PDF with a single command
  </Card>

  <Card title="Rich customization" icon="sliders">
    Add line numbers, page numbers, remove comments, and control formatting options
  </Card>

  <Card title="Multiple output modes" icon="files">
    Generate a single PDF for the entire repository or one PDF per file
  </Card>
</CardGroup>

## Use cases

<CardGroup cols={3}>
  <Card title="Code reviews" icon="magnifying-glass">
    Print repositories for offline review and annotation
  </Card>

  <Card title="Education" icon="graduation-cap">
    Share codebases with students in a portable format
  </Card>

  <Card title="Documentation" icon="book">
    Archive snapshots of your codebase at specific points in time
  </Card>

  <Card title="AI training" icon="brain">
    Prepare code documents for training language models
  </Card>

  <Card title="Portfolio" icon="briefcase">
    Create professional PDF presentations of your projects
  </Card>

  <Card title="Compliance" icon="shield-check">
    Generate auditable records of source code
  </Card>
</CardGroup>

## Quick links

<CardGroup cols={2}>
  <Card title="Installation" icon="download" href="/installation">
    Get repo2pdf installed on your system in seconds
  </Card>

  <Card title="Quick start" icon="rocket" href="/quickstart">
    Convert your first repository to PDF in under a minute
  </Card>

  <Card title="Configuration" icon="gear" href="/usage/configuration">
    Customize ignored files and formatting options
  </Card>

  <Card title="GitHub" icon="github" href="https://github.com/BankkRoll/Repo-to-PDF">
    View the source code and contribute to the project
  </Card>
</CardGroup>

## Community

repo2pdf is open source and welcomes contributions from developers around the world. Whether you're reporting bugs, suggesting features, or contributing code, your input helps make repo2pdf better for everyone.

<Note>
  repo2pdf requires Node.js 18 or higher and git (for remote repositories)
</Note>