Skip to content
Get started

allyhub doc cover set

Sets one of AllyHub's covers on a doc, as the editor's gallery does: its SVG written beside the doc's file (cover-<name>.svg) and named in the front matter's cover; the rest of the file keeps its bytes

Terminal window
allyhub doc cover set [doc] [name]
Argument Type What it is
<doc> string The doc, by its file or its id in allyhub.yaml
<name> dots, scales, bay, stacks, steam, dusk, lake The cover (allyhub doc cover list): dots, scales, bay, stacks, steam, dusk, lake

--dir <value>: the project’s folder; default the one around where it is run. --json: print the result as JSON.

Terminal window
allyhub doc cover set plan dots
allyhub doc cover set reports/q3 lake

0 when it succeeds; the others are listed in Exit codes.

docs: Writing a doc

doc cover list → doc cover set → check → frames → inspect pages → dev → render

Was this page helpful?