Reference/Static Site/

README and Index

README.md at the wiki root is special-cased: it becomes index.html instead of scraps/readme.html. This lets the wiki render correctly both on the static site and directly on GitHub.

One limitation: autolinks inside the wiki root README.md fall back to plain links — the OGP card is suppressed on the index page.

Reference/

Static Site

#Emit/Static Site The static site is one of the emit targets Scraps compiles to. The other first-class target is JSON from CLI Overview. See What is Scraps?#more-than-a-static-site-generator for why Scraps decenters SSG from its narrative while keeping the HTML output fully supported. Pipeline ![[Reference/Static Site/Pipeline]] Output structure ![[Reference/Static Site/Output Structure]] README and the index page ![[Reference/Static Site/README and Index]] Search index ![[Reference/Static Site/Search Index]] Color scheme ![[Reference/Static Site/Color Scheme]] Tag pages ![[Reference/Static Site/Tag Pages]] Sort and pagination ![[Reference/Static Site/Sort and Pagination]] Configuration schema The full schema lives in Configuration ([ssg] and root level); the same [ssg] block is embedded below for in-place reading. ![[Reference/Configuration#ssg-section]]
Reference/Markdown/

Autolink

#Notation/Markdown Bare URLs wrapped in angle brackets render as OGP cards on the static site, fetching the target page's Open Graph metadata at build time. <https://github.com/boykush/scraps> The example above renders as a live OGP card on this page: https://github.com/boykush/scraps Use autolinks deliberately: the card is heavy compared to an inline link. Reach for <…> when the link is a "you should look at this" pointer (canonical source, prior art, recipe target). Use [text](url) for inline references that the reader skims past. The wiki root README.md falls back to plain links — see README and Index for the limitation.