allyhub inspect pages
A doc's pages as render prints them, measured from the PDF: the space at each page's foot, blocks broken over pages with their lines on each, headings near a foot, short last lines, content past the column; and a picture of the pages, each block outlined and labelled by its line in the doc's file
allyhub inspect pages [doc] [options]Arguments
Section titled “Arguments”| Argument | Type | What it is |
|---|---|---|
<doc> |
string | The doc, by its file or its id in allyhub.yaml |
Options
Section titled “Options”| Option | Type | Default | What it does |
|---|---|---|---|
--kind |
list of string | Only facts of these kinds: page-fill, page-split, page-heading, page-short-line, page-overflow, page-kinsoku, page-figure, page-picture, page-grid, page-contents | |
--heading-lines |
integer | 3 |
A heading is listed when fewer lines than this follow it on its page |
--short-line |
integer | 2 |
A paragraph’s last line is listed when it holds this many letters or fewer (punctuation not counted) |
--all |
boolean | false |
Every finding on a line of its own, and every heading and every paragraph’s last line |
--page |
string | Draw only these pages, large: 2, 2-4, 1,5 | |
--out |
string | Where the picture goes; default .allyhub/work/inspect/<doc>/pages.webp |
Global options
Section titled “Global options”--dir <value>: the project’s folder; default the one around where it is run. --json: print the result as JSON.
Examples
Section titled “Examples”allyhub inspect pages launch/planallyhub inspect pages launch/plan --kind page-split,page-headingallyhub inspect pages launch/plan --page 3-4 --allExit codes
Section titled “Exit codes”0 when it succeeds; the others are listed in Exit codes.
In the work
Section titled “In the work”docs: Writing a doc
doc cover list → doc cover set → check → frames → inspect pages → dev → render