Exporting Reports

Export options

Repolyze offers multiple ways to export and share your repository analysis results.

Plain Text

Copy a readable text summary to clipboard

Markdown

Copy formatted markdown for documentation

PDF Report

Download a professional PDF report

Accessing export options

Export actions are located in the analysis header, next to the branch selector.

Open the summary actions menu

Look for the action buttons in the top-right corner of the analysis results.

Quick copy button: Click the copy icon to instantly copy as plain text
More options menu: Click the three-dot menu for additional formats

Select your export format

Choose from the dropdown menu:

Copy as Plain Text: Simple, readable format
Copy as Markdown: Formatted for GitHub/docs
Download as PDF: Professional report

Use the exported content

Copied content is available in your clipboard
PDF downloads to your default downloads folder

Plain text export

Quick and simple format for sharing in chat, email, or issue trackers.

What’s included

Repository name and metadata
Overall score and category breakdown
Technology stack
Key insights (top 5)
Refactoring opportunities
Quick start commands

Example output

# Repository Analysis: repolyze

Overall Score: 85/100 (Good)

Scores:
- Code Quality: 87/100
- Documentation: 72/100
- Security: 90/100
- Maintainability: 88/100
- Test Coverage: 65/100
- Dependencies: 80/100

Technology Stack:
- Next.js
- TypeScript
- Tailwind CSS
- React

Top Insights:
- [STRENGTH] TypeScript with strict mode enabled
- [WARNING] Test coverage could be improved
...

Plain text format is ideal for pasting into GitHub issues, Slack messages, or team chat.

Markdown export

Formatted markdown perfect for documentation, READMEs, or GitHub wikis.

What’s included

Everything from plain text export, plus:

Markdown formatting (headers, lists, code blocks)
Collapsible sections
Proper link formatting
Table formatting for scores

Example output

# Repository Analysis: repolyze

## Overview

**Overall Score**: 85/100 (Good)

| Category | Score |
|----------|-------|
| Code Quality | 87/100 |
| Documentation | 72/100 |
| Security | 90/100 |
| Maintainability | 88/100 |
| Test Coverage | 65/100 |
| Dependencies | 80/100 |

## Technology Stack

- Next.js
- TypeScript
- Tailwind CSS
- React

## Key Insights

### Strengths

- TypeScript with strict mode enabled
- Comprehensive error handling

### Suggestions

- Improve test coverage
- Add API documentation

## Quick Start

```bash
npm install
npm run dev

Markdown copy implementation

The markdown export is handled by the copySummary() function in lib/share.ts:

export async function copySummary(
  result: Partial<AnalysisResult>,
  format: 'text' | 'markdown'
): Promise<boolean> {
  try {
    const content = format === 'markdown' 
      ? formatAsMarkdown(result)
      : formatAsText(result);
    
    await navigator.clipboard.writeText(content);
    return true;
  } catch (error) {
    console.error('Failed to copy:', error);
    return false;
  }
}

PDF report export

Professional, print-ready PDF report with comprehensive analysis details.

PDF report features

Professional design

Custom “Caffeine” color palette (warm browns, creams)
Rounded corners and modern typography
Color-coded score indicators
Visual progress bars and circular score display

Comprehensive content

Hero section: Repository name, description, stars, forks, language
Score card: Overall score with circular progress + 6 category scores
Executive summary: AI-generated overview
Purpose & audience: What it does and who it’s for
Technology stack: Pills/badges for each technology
Quick start: Terminal-style command blocks
Project structure: Table of key folders
Key insights: Color-coded cards with priority badges
Refactoring opportunities: Impact and effort ratings
Automation suggestions: Organized by type

Multi-page layout

Automatic pagination with intelligent page breaks
Consistent headers and footers
Page numbers and generation date
Cream background on all pages

Generating a PDF

Click Download as PDF from the more options menu.

Initiate download

The PDF generation begins immediately with a “Generating PDF…” status indicator.

Wait for generation

PDF generation typically takes 2-5 seconds depending on analysis complexity.

The button shows a pulsing animation while generating.

Download automatically

Once complete, the PDF downloads automatically to your default downloads folder.Filename format: {repository-name}-analysis.pdfExample: repolyze-analysis.pdf

PDF structure

Page 1: Overview

┌─────────────────────────────────────┐
│ Hero Section                        │
│ - Repository name & metadata        │
│ - Stars, forks, language, license   │
├─────────────────────────────────────┤
│ Score Card                          │
│ - Circular overall score display    │
│ - 6 category scores with bars       │
├─────────────────────────────────────┤
│ Executive Summary                   │
│ - AI-generated overview             │
├─────────────────────────────────────┤
│ Purpose & Target Audience           │
└─────────────────────────────────────┘

Page 2: Technical Details

┌─────────────────────────────────────┐
│ Technology Stack                    │
│ - Colored pills for each tech       │
├─────────────────────────────────────┤
│ Quick Start Commands                │
│ - Terminal-style code blocks        │
├─────────────────────────────────────┤
│ Project Structure Table             │
│ - Folder descriptions               │
└─────────────────────────────────────┘

Page 3+: Insights & Recommendations

┌─────────────────────────────────────┐
│ Key Insights Cards                  │
│ - Color-coded by type               │
│ - Priority badges                   │
├─────────────────────────────────────┤
│ Refactoring Opportunities Table     │
│ - Impact and effort ratings         │
├─────────────────────────────────────┤
│ Automation Suggestions Table        │
│ - Organized by type                 │
└─────────────────────────────────────┘

PDF color coding

Insights and scores use semantic colors:

Strengths

Green for positive findings

Warnings

Gold/amber for cautions

Issues

Red for problems

PDF implementation details

The PDF generator uses jsPDF library with custom rendering:

PDF generation code structure

File: lib/pdf-export.ts (850 lines)Key functions:

generatePDFReport(): Main PDF generation (lines 9-812)
downloadPDFReport(): Triggers download (lines 814-835)
drawScoreCard(): Renders score visualization (lines 150-257)
drawInsightsCards(): Creates insight cards (lines 571-690)
drawTable(): Generic table renderer (lines 397-546)

Color palette (lines 24-43):

const colors = {
  darkRoast: { r: 38, g: 28, b: 24 },    // Headings
  arabica: { r: 87, g: 63, b: 51 },      // Body text
  caramel: { r: 183, g: 135, b: 85 },    // Accents
  cream: { r: 250, g: 247, b: 243 },     // Background
  success: { r: 82, g: 126, b: 86 },     // Good scores
  warning: { r: 186, g: 142, b: 68 },    // Medium scores
  danger: { r: 172, g: 88, b: 78 },      // Low scores
};

Export use cases

Stakeholder reports

Use PDF exports for:

Executive summaries
Client deliverables
Audit documentation
Project presentations

Team collaboration

Use Markdown exports for:

GitHub wiki pages
Team documentation
Project READMEs
Confluence/Notion pages

Use Plain Text exports for:

Slack/Teams messages
Email updates
Issue tracker comments
Quick references

Troubleshooting

Copy not working

If clipboard operations fail:

Ensure your browser supports Clipboard API
Check that you’ve granted clipboard permissions
Try using HTTPS (required for Clipboard API)
Use a modern browser (Chrome, Firefox, Safari, Edge)

PDF download fails

If PDF generation fails:

Check browser console for errors
Verify pop-ups aren’t blocked
Ensure sufficient browser memory
Try a smaller repository or refresh the page
Check that JavaScript is enabled

Export button disabled

Export buttons may be disabled if:

Analysis is still in progress
Analysis failed or is incomplete
Required data is missing
Try re-running the analysis

Copy confirmation feedback

When you copy content, you’ll see visual confirmation:

Icon change: Copy icon changes to checkmark
Color change: Button turns primary color
Tooltip update: Shows “Copied!” message
Duration: Feedback displays for 2 seconds

const handleCopy = async () => {
  const success = await copySummary(result, format);
  if (success) {
    setCopied(true);
    setTimeout(() => setCopied(false), 2000);
  }
};

Best practices

Choose the right format

PDF: For formal reports, presentations, or archival
Markdown: For documentation sites or wikis
Plain text: For quick sharing or issue tracking

Include context

Add notes about:

Branch analyzed
Date of analysis
Purpose of the analysis
Follow-up actions needed

Regular snapshots

Export reports regularly to track improvement over time.

Share responsibly

Be mindful when sharing:

May contain sensitive project information
Check security findings before public sharing
Redact private repository details if needed

Next steps

Analyzing Repositories

Learn what data gets included in exports

Understanding Scores

Interpret score breakdowns in your reports

Get Started

Core Features

User Guide

Account & Billing

Exporting Reports

Export options

Plain Text

Markdown

PDF Report

Accessing export options

Plain text export

What’s included

Example output

Markdown export

What’s included

Example output

PDF report export

PDF report features

Generating a PDF

PDF structure

Page 1: Overview

Page 2: Technical Details

Page 3+: Insights & Recommendations

PDF color coding

Strengths

Warnings

Issues

PDF implementation details

Export use cases

Stakeholder reports

Team collaboration

Troubleshooting

Copy confirmation feedback

Best practices

Next steps

Analyzing Repositories

Understanding Scores

Build docs developers (and LLMs) love

Get Started

Core Features

User Guide

Account & Billing

​Export options

Plain Text

Markdown

PDF Report

​Accessing export options

​Plain text export

​What’s included

​Example output

​Markdown export

​What’s included

​Example output

​PDF report export

​PDF report features

​Generating a PDF

​PDF structure

​Page 1: Overview

​Page 2: Technical Details

​Page 3+: Insights & Recommendations

​PDF color coding

Strengths

Warnings

Issues

​PDF implementation details

​Export use cases

​Stakeholder reports

​Team collaboration

​Quick sharing

​Troubleshooting

​Copy confirmation feedback

​Best practices

​Next steps

Analyzing Repositories

Understanding Scores

Build docs developers (and LLMs) love

Export options

Accessing export options

Plain text export

What’s included

Example output

Markdown export

What’s included

Example output

PDF report export

PDF report features

Generating a PDF

PDF structure

Page 1: Overview

Page 2: Technical Details

Page 3+: Insights & Recommendations

PDF color coding

PDF implementation details

Export use cases

Stakeholder reports

Team collaboration

Quick sharing

Troubleshooting

Copy confirmation feedback

Best practices

Next steps