From Repository to Printable Docs
A docs folder is a graph of files, not a single document. Exporting it without breaking the links is most of the work.
本頁目錄
Repository docs are a graph, not a file
Open a README and everything looks local: images in docs/assets, includes like {{#include ../shared/limits.md}}, links to sibling pages.
Export that page on its own and the image path resolves against your laptop, the include stays as literal template text, and the sibling links point nowhere. The Markdown was fine; the context was missing.
What an importer has to preserve
| Element | Why it breaks on its own | What import should do |
|---|---|---|
| Relative images |  has no meaning outside the repo |
Copy the asset tree and keep paths |
| Include files | Template syntax is not Markdown | Expand includes before render, fail loudly if missing |
| Cross-page links | They assume the docs site routes | Keep them as text or rewrite to page references |
| Branch and folder | README on main may differ from the release tag |
Let you pick branch, tag and subdirectory |
The first two decide whether the PDF looks like the repo. The last two decide whether it is the right version of the repo.
The plan and repository boundary
Repository import is available on Pro and in the Thesis Pack (a one-time purchase that includes Pro features permanently), and it is designed for public repositories:
https://github.com/acme/platform-docs
branch: main
directory: docs
Private hosting and token management are outside the product scope. If the docs live behind a login, export the pages you need as Markdown and use the studio instead.
A checklist before importing
- Pick the ref you mean. A tag is safer than
mainwhen you are producing a release PDF. - Check that images are committed. Files ignored by
.gitignoreare not in the archive. - Look for includes. A missing include target should produce a visible diagnostic, not a silent gap.
- Check submodules. Their content is not part of the archive; if the docs depend on them, import those pages separately.
When you cannot import
Paste the Markdown into the studio and attach the asset folder. The renderer is the same; you lose the automatic path handling, not the output quality.
Try it
Public GitHub and GitLab imports are part of Pro and the Thesis Pack. To see the output first, open the Markdown studio and export the default document — no repository required.
For diagrams and formulas that live next to the docs, use the same editor and review the PDF feature set.
What we do not claim
Private repositories, submodule contents and repository authorization are not supported. Very large monorepos are limited by the archive size, and a missing include or image is reported as a diagnostic rather than silently replaced with a placeholder.
同一個排版引擎只差一次點擊。開啟空白編輯器,貼上 Markdown,準備好就匯出。