> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pwnbook.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Wiki

> Pwnbook's wiki gives every engagement a collaborative, markdown-based knowledge base. Write findings, document methodology, and share notes internally or with external stakeholders.

## Overview

Each engagement in Pwnbook includes a fully collaborative wiki. The wiki is where your team writes notes, documents findings, records methodology, and builds any free-form content that doesn't fit neatly into a structured report.

Wiki pages support rich markdown — headings, tables, code blocks, links, and more — giving you the flexibility to write exactly what you need.

## Creating a wiki page

1. Open an engagement and navigate to the **Wiki** tab.
2. Click **New Page**.
3. Enter a title for the page.
4. Click **Create**.
5. Start writing in the markdown editor.

Changes are saved automatically as you type.

## Markdown support

Wiki pages support standard markdown syntax plus some extras:

| Element         | Syntax                         |
| --------------- | ------------------------------ |
| Heading         | `# H1`, `## H2`, `### H3`      |
| Bold            | `**bold text**`                |
| Italic          | `*italic text*`                |
| Code (inline)   | `` `code` ``                   |
| Code block      | ` ```language ``` `            |
| Link            | `[label](url)`                 |
| Image           | `![alt text](url)`             |
| Table           | Standard markdown table syntax |
| Blockquote      | `> quote text`                 |
| Ordered list    | `1. item`                      |
| Unordered list  | `- item`                       |
| Horizontal rule | `---`                          |

<Tip>Use code blocks with a language identifier (e.g., ` ```bash ` or ` ```python `) for syntax highlighting in your documented exploit code or payloads.</Tip>

## Organizing pages

You can create multiple pages per engagement and organize them into a hierarchy:

* Use descriptive titles that make the content scannable (e.g., "Methodology", "Findings", "IDOR in /api/users", "Recon Notes")
* Nest pages under parent pages by dragging them in the page list
* Pin important pages to the top of the wiki sidebar

## Collaborative editing

Multiple team members can view and edit wiki pages simultaneously. Edits from other users appear in real time, so you can collaborate without worrying about overwriting each other's work.

## Sharing wiki pages externally

You can share individual wiki pages — or the entire engagement wiki — with external stakeholders (e.g., a client's development team) using share links. Share links do not require a Pwnbook account to view.

### Creating a share link

1. Open the wiki page you want to share.
2. Click the **Share** button in the top toolbar.
3. Choose whether to share this page only, or the full wiki.
4. Set an expiry date (optional but recommended).
5. Click **Create Link**.
6. Copy the generated URL and send it to the recipient.

### Managing share links

1. Navigate to the **Wiki** tab.
2. Click **Share Links** in the sidebar.
3. View all active share links, their expiry dates, and view counts.
4. Click **Revoke** next to any link to immediately invalidate it.

<Warning>Share links provide read access to the shared content without authentication. Only share links with authorized recipients. Always set an expiry date for client-facing shares.</Warning>

## Exporting wiki content

You can export the full wiki as a ZIP archive of markdown files, or export individual pages as PDF or HTML for inclusion in deliverables.

To export:

1. Click the **...** menu in the Wiki tab.
2. Select **Export Wiki**.
3. Choose the format (Markdown ZIP, PDF).
4. The download starts automatically.

## Best practices

<AccordionGroup>
  <Accordion title="Document as you go">
    Write notes in the wiki throughout the engagement, not just at the end. Real-time documentation captures context that's easy to forget later.
  </Accordion>

  <Accordion title="Use a consistent findings format">
    Standardize how you write findings: title, severity, description, impact, reproduction steps, and remediation. This makes it much easier to compile the final report.
  </Accordion>

  <Accordion title="Keep the wiki organized">
    Create a top-level page that acts as a table of contents for the engagement. Link to sub-pages for recon notes, findings, and methodology.
  </Accordion>
</AccordionGroup>