repo2pdf

repo2pdf 是一種工具,可將 GitHub 儲存庫轉換為 PDF 檔案。它會複製該儲存庫、處理檔案,然後建立 PDF。 --- 文件

repo2pdf 是什麼?

repo2pdf 是一種工具,可將 GitHub 儲存庫轉換為 PDF 檔案。它會複製該儲存庫、處理檔案,然後建立 PDF。 --- 文件:https://bankkroll-repo2pdf.mintlify.app

repo2pdf 概覽

這是什麼

repo2pdf 是一個能將 GitHub 儲存庫轉換為 PDF 檔案的工具。它會先複製儲存庫、處理檔案,然後產生 PDF。此工具可透過 NPX 使用,或直接複製儲存庫來安裝。本專案為開放原始碼,採用 MIT 授權。

主要功能

  • 將 GitHub 儲存庫轉換為格式良好的 PDF 檔案。
  • 支援遠端(GitHub)與本機儲存庫。
  • 可選擇在 PDF 中加入行號、頁碼及語法高亮。
  • 能夠移除程式碼中的註解與空白行。
  • 可產生單一 PDF 涵蓋整個儲存庫,或每個檔案各別產生 PDF。
  • 透過 repo2pdf.ignore 檔案支援自訂忽略清單。
  • 自動忽略二進位檔案與特定目錄(例如 .png、.git)。

使用情境

  • 教學與教材:為課程或工作坊建立程式碼儲存庫的 PDF。
  • 程式碼審查:產生靜態、可攜帶的程式碼版本供審查。
  • 離線參考:無需網路即可存取程式碼。
  • 封存:以 PDF 格式保存儲存庫的快照。
  • AI 訓練:為機器學習模型準備程式碼資料。
  • 文件嵌入:將程式碼嵌入報告、文件或簡報中。

快速開始

使用 NPX 執行 repo2pdf:shellnpx repo2pdf透過複製儲存庫安裝:shellgit clone https://github.com/BankkRoll/repo2pdfcd repo2pdfnpm installnpm run buildnpm start系統需安裝 Node.js 18 或更新版本,以及 git(用於非本機儲存庫)。

授權與價格

repo2pdf 為開放原始碼軟體,採用 MIT 授權。價格類型為開放原始碼(免費)。

內容整理自該專案公開的 README 與儲存庫資訊。

將此徽章加入你的 README

Featured on YunoDB 徽章樣式與說明

你是這個專案的維護者嗎?展示它已收錄於 YunoDB。

Markdown[![Featured on YunoDB](https://yunodb.com/badge/bankkrollrepo2pdf.svg)](https://yunodb.com/tools/bankkrollrepo2pdf?utm_source=github&utm_medium=badge)
HTML<a href="https://yunodb.com/tools/bankkrollrepo2pdf?utm_source=github&utm_medium=badge"><img src="https://yunodb.com/badge/bankkrollrepo2pdf.svg" alt="Featured on YunoDB" height="20"></a>