Inkies Docs

Export

Download published articles as a Markdown ZIP or JSON export.

The website detail page can export its published articles in Markdown or JSON. Export files are generated from the same published article records exposed by the pull API.

Markdown ZIP

The archive contains one Markdown file per article, one cover file when an article has a cover, and an index:

articles/<slug>.md
covers/<slug>.<extension>
index.json

Cover extensions are selected from the stored media type:

image/jpeg -> jpg
image/webp -> webp
other       -> png

Article Markdown contains YAML frontmatter for the title, description, slug, dates, keyword, intent, cover path, cover alt, sources, and internal links. The article Markdown follows the frontmatter.

Example shape:

---
title: Example article
description: The article description
slug: example-article
date: 2026-09-22T00:00:00.000Z
updated: 2026-09-22T00:00:00.000Z
keyword: example keyword
intent: informational
cover: ../covers/example-article.webp
coverAlt: Example cover
sources:
  - url: https://example.com/source
    title: Example source
internalLinks: []
---

Article Markdown.

JSON export

The JSON file has this root shape:

type Export = {
  format: "inkies-export";
  version: 1;
  exportedAt: string;
  site: {
    name: string;
    url: string;
    blogPath: string;
  };
  articles: ExportArticle[];
};

type ExportArticle = {
  slug: string;
  title: string;
  description: string;
  intent: string;
  keyword: string;
  markdown: string;
  publishedAt: number;
  updatedAt: number;
  sources: { url: string; title: string }[];
  internalLinks: { url: string; anchor: string }[];
  html: string;
  coverImage: {
    url: string;
    alt: string;
    width: number;
    height: number;
  } | null;
};

Each JSON article includes the published article fields, rendered html, sources, internal links, and cover metadata. The JSON export does not include raw cover bytes. Use the cover URL or the Markdown ZIP when the binary cover is needed.

On this page