Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/AsyncFuncAI/deepwiki-open/llms.txt

Use this file to discover all available pages before exploring further.

Once DeepWiki has generated a wiki, you can download the entire content as a self-contained file. Two formats are available: Markdown for human-readable documentation and JSON for programmatic consumption. Both exports include every wiki page and are produced by the POST /export/wiki endpoint in the DeepWiki API.

​
Triggering an export from the UI

Open a generated wiki and locate the export controls in the top-right area of the wiki view. Select either Markdown or JSON, then click the download button. The browser will receive a file attachment with a name in the format {repo}_wiki_{timestamp}.md or {repo}_wiki_{timestamp}.json, where {repo} is the last segment of the repository URL and {timestamp} is a YYYYMMDD_HHMMSS string.

​
Export formats

The Markdown export is a single .md file suitable for reading in any text editor, publishing to a docs site, or committing to the repository itself.Structure:
  • A top-level heading with the repository URL
  • A “Generated on” timestamp
  • A Table of Contents with anchor links to every page
  • Each page rendered as a level-2 heading with:
    • A Related Pages sub-section listing linked topics (when present)
    • The full page content
    • A horizontal rule separator between pages
Filename pattern: {repo}_wiki_{YYYYMMDD_HHMMSS}.md

​
Format examples

# Wiki Documentation for https://github.com/example/repo

Generated on: 2024-01-15 10:30:00

## Table of Contents

- [Overview](#overview)
- [API Reference](#api-reference)

<a id='overview'></a>

## Overview

### Related Pages

Related topics: [API Reference](#api-reference)

This repository provides...

---

<a id='api-reference'></a>

## API Reference

Details about the API...

---

​
API endpoint

You can call the export endpoint directly without the UI. Send a POST request to /export/wiki with the repository URL, the list of wiki pages, and the desired format. 
curl -X POST http://localhost:8001/export/wiki \
  -H "Content-Type: application/json" \
  -d '{
    "repo_url": "https://github.com/example/repo",
    "format": "json",
    "pages": [
      {
        "id": "overview",
        "title": "Overview",
        "content": "Page content here...",
        "filePaths": ["README.md"],
        "importance": "high",
        "relatedPages": []
      }
    ]
  }' \
  --output repo_wiki.json
The response is a file download (Content-Disposition: attachment) with the appropriate Content-Type header (text/markdown or application/json).

​
Request body schema

FieldTypeDescription
repo_urlstringRepository URL, used to derive the filename
format"markdown" | "json"Output format
pagesarray of WikiPagePages to include in the export

​
WikiPage object

FieldTypeDescription
idstringUnique page identifier
titlestringPage title
contentstringFull page content (Markdown)
filePathsstring[]Source files the page was generated from
importance"high" | "medium" | "low"Relative importance of the page
relatedPagesstring[]IDs of related pages

Build docs developers (and LLMs) love

Get started for freeTalk to us