Import & Export
Importing
Composez can import existing manuscripts from two sources:
Novelcrafter Import
Import a Novelcrafter Markdown export (zip file or extracted directory):
> /import novelcrafter ~/Downloads/my-novel-export.zip
Or from an extracted directory:
> /import novelcrafter ~/Downloads/my-novel-export/
This imports:
- Narrative structure (acts, chapters, scenes with prose and summaries)
- Database entries (characters, locations, items, etc.)
- Snippets and other reference material
The import:
- Checks that
novel/anddb/have no uncommitted changes - Clears the existing
novel/anddb/directories - Runs the import
- Commits the result automatically
The Novelcrafter import replaces your existing narrative structure and database. Commit or stash any uncommitted changes first.
Markdown Import
Import a plain Markdown file using heading levels to determine structure:
> /import markdown ~/Documents/draft.md
Heading mapping:
| Markdown Heading | Composez Level |
|---|---|
# Heading |
Act |
## Heading |
Chapter |
### Heading |
Scene |
Content under each ### heading becomes the scene’s PROSE.md. The heading text becomes the directory title.
Markdown import only creates the narrative structure. You’ll need to create database entries (characters, locations, etc.) manually afterward.
Exporting
Markdown Export
Export your entire manuscript as a single Markdown file:
> /export markdown
> /export markdown my-novel.md
The output includes:
- Act titles as
#headings - Chapter titles as
##headings - Scene titles as
###headings - Scene prose under each heading
- Scene separators (
***) between scenes within a chapter
DOCX Export
Export as a styled Word document:
> /export docx
> /export docx my-novel.docx
Requires the python-docx package:
pip install python-docxThe DOCX export includes:
- Proper heading styles for acts, chapters, and scenes
- Scene separators
- Standard manuscript formatting
EPUB Export
Export as an EPUB ebook:
> /export epub
> /export epub my-novel.epub
Requires the ebooklib package:
pip install ebooklibThe EPUB includes:
- Book title and author from
db/core/metadata.yml - Chapter-based structure
- Cover image from
cover.jpgorcover.pngif present - Proper EPUB metadata and navigation
Default Filenames
If you don’t specify a filename, defaults are used:
| Format | Default Filename |
|---|---|
| Markdown | export.md |
| DOCX | export.docx |
| EPUB | export.epub |
Files are created in the project root directory.
Metadata
Export metadata (title, author) comes from db/core/metadata.yml:
title: The Lighthouse
author: Elena VasquezIf the file doesn’t exist, defaults to “Untitled” and “Unknown”.