Skip to content
Developer Codex
Pages & Editor

Export Content

Inklings stores your content locally in a workspace file. The export feature extracts that content to plain markdown files — portable, readable by any text editor, and compatible with other tools.

  1. Open the File menu or the workspace options.
  2. Select Export.
  3. Choose a destination folder on your filesystem where the exported files will be written.
  4. Confirm.

The export runs and reports how many pages were written. The destination folder now contains .md files corresponding to your pages.

Every non-deleted page in the workspace is exported. Pages in the Trash are not included.

Directory structure mirrors your hierarchy

Section titled “Directory structure mirrors your hierarchy”

The export directory mirrors the parent-child structure of your sidebar:

  • Root-level pages are exported as flat files directly in the destination folder: thornwall-keep.md
  • Child pages are exported into subdirectories named after their parent: geography/thornwall-keep.md
  • Grandchild pages follow the same pattern: geography/thornwall-keep/the-verdant-undercity.md

Every exported file begins with a YAML frontmatter block — a structured header section recognized by many markdown tools — containing page metadata:

---
id: "550e8400-e29b-41d4-a716-446655440000"
title: "Magistrate Thorne"
page_type: "page"
icon: "user"
icon_color: "purple"
created_at: "2026-01-15T09:30:00Z"
updated_at: "2026-02-20T14:15:00Z"
---

Fields present in every export:

  • id — the page’s unique identifier
  • title — the page title
  • page_type"page" or "folder", or the slug of a custom type
  • created_at and updated_at — RFC 3339 timestamps

Fields present only when set:

  • icon — the Lucide icon name (e.g., "star", "flame")
  • icon_color — the color token (e.g., "purple", "yellow")

Custom properties set via the properties system appear after the system fields, in alphabetical order by property key.

Immediately after the frontmatter closing ---, each exported file includes the page title as an H1 heading:

# Magistrate Thorne

The body content follows after this heading.

Wiki-links are not converted to plain text or URLs. They export in the [[Display Text|slug]] format:

Thorne governs from [[Thornwall Keep|thornwall-keep]], which she has done for [[The Sundering|the-sundering]] since the end of the war.

This format is Inklings’s native wiki-link syntax. Other tools that understand wiki-link syntax can parse it. Tools that don’t will see the raw [[...]] text.

Pages with the Folder type export with page_type: "folder" in their frontmatter. The folder structure in the export directory is determined by the page hierarchy, not by the page type — a regular page can be a parent too.

Exported markdown files can be re-imported into a new workspace via the import dialog. The YAML frontmatter is preserved verbatim, and wiki-links remain intact. If you export, move a project elsewhere, and import — the structure, metadata, and links survive the round-trip.

Was this page helpful?