LibraryEditorial layoutCards layout
Practical advice for writing a reference that answers a task quickly, with literal code, deliberate links and recorded sources.
Updated
A useful reference answers a specific question at the moment you need it. Put the answer first, then just enough context to use it well.
Use a short, descriptive title. Write “Select a line” instead of “Selection functionality.” Keep related actions together and give each card one job.
| Prefer | Instead of |
|---|---|
| A concrete action | An abstract category |
| One small example | Every possible option |
| A stable link | “See above” |
Code blocks stay inert and readable. They are never instructions for the compiler to run.
printf '%s\n' '<hello>'
Use the copy control when you need the exact snippet.
Use stable card links, a selected sheet, or an explicit HTTPS URL such as the Go documentation.
Unsafe URL schemes are diagnosed. Raw HTML is displayed as text; images are retained as links without fetching them.
code for literal values.
Preserve the source repository, revision, path, license and attribution when importing an existing reference.
Technical compatibility and permission to redistribute are separate decisions.