There is a Description setting but I cannot find anywhere to type one, and nothing shows
What you are seeing
You can see a Description setting for the Github file macro, but there is nowhere to type one, and nothing shows on the page.
#Why it happens
The Description setting is not used. The Browse GitHub picker never saves a description, so nothing can appear.
#What to do
Ignore it. Put any explanatory text in normal page content above or below the macro.
#Settings involved
Setting | Where | What it does |
|---|---|---|
There is no GitHub settings screen | Nowhere | GitHub adds no tab to Capable global settings or space settings. There is also no admin "connect the site to GitHub" screen. |
Turn GitHub on or off per space | Per-space capability setting (always off or always on) | Always off hides the Github byline in that space. Always on shows it even on pages with no GitHub macro. This affects the byline only. Macros still render. |
#Limits that apply here
Limit | Value | What happens |
|---|---|---|
File content is not stored | - | Every time a Github file macro is shown, the file is fetched from GitHub again. A page with many GitHub macros uses up your GitHub request allowance on every view. |
GitHub rate limits | Not handled | Capable does not retry when GitHub rate limits a request. A GitHub 403 caused by rate limiting is reported as an access error, as though nobody has access. |
Large files | - | Large files can be slow to load, or fail. |
#Related
Cannot find the GitHub macro in Capable's macro list, the command palette, or the automation "Insert
The macro is deliberately marked as hidden from Capable's own listings.
Readers see "Connect a GitHub account with access to this repository to view this file"
The file is in a private repository and that reader has no connected GitHub account that c
Permissions and access
The rest of this family.
Found it? Good.
