GitLab Docs Live on Branches
A GitLab repository is not one document — it is a tree of documents at a particular commit. Exporting the wrong ref produces a correct PDF of the wrong release.
On this page
The ref is part of the document
On main, the install section is three paragraphs and the API table has nine rows. On the v2.4 tag, the same files are shorter and the table has six rows.
Both are valid PDFs. Only one matches the software the reader is running. That is why the importer asks for a branch, tag or commit before it copies anything: the ref is not a detail, it is part of what the document says.
What the importer reads
| Input | Why it matters |
|---|---|
| Branch / tag / commit | Selects the version of the docs |
| Documentation directory | Keeps the repo root out of the PDF |
| Public archive endpoint | No token, no stored credentials |
| Relative images and includes | Turns a tree of files into one readable document |
A layout that imports cleanly looks like this:
docs/
index.md
install.md
assets/
architecture.png
Point the importer at docs/, not at the repository root. The result is a document with an install section and one image, instead of a PDF that starts with a CI config file.
Includes and the CI folder
Documentation that is assembled by CI usually keeps includes in the same tree, for example docs/_includes/limits.md. As long as those files are committed, the importer keeps the paths and the include can be expanded during render.
Generated artifacts are a different story: a PDF built from a CI job's output directory has to be reproduced locally. The importer reads the repository archive, not the pipeline's workspace.
The public-repository boundary
GitLab import is available on Pro and in the Thesis Pack, and targets public projects. Private hosting, deploy tokens and group-level permissions are outside the product scope. If the docs are private, export the pages as Markdown and use the studio.
A short checklist
- Pin a tag for release PDFs.
mainis a moving target. - Choose the docs directory. The repository root usually contains things that do not belong in a document.
- Confirm images are committed. Anything ignored by
.gitignoreis not in the archive. - Check includes. A missing include target should produce a diagnostic, not a silent gap.
Try it
Public GitLab and GitHub 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 projects, deploy tokens and CI artifacts are not supported. Submodule contents are not part of the archive, and very large monorepos are limited by archive size.
The same print renderer is one click away. Open a blank editor, paste your Markdown, and export when it is ready.