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
allyhub doc cover set [doc] [name]Arguments
Section titled “Arguments”| 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 |
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 doc cover set plan dotsallyhub doc cover set reports/q3 lakeExit 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