TechArticle

wiki render

Infobox

headline
wiki render
description
Update inline SPARQL result tables in markdown files.

Find <!-- sparql:start --> ... <!-- sparql:end --> regions in markdown, run the embedded query against the wiki graph, and rewrite the table (or (no results)) in place.

Silent on success by default. See Design Philosophies.

Usage

wiki render
wiki render wiki/Report.md
wiki render wiki/people/alpha.md wiki/projects/beta.md
wiki render wiki/people/*.md
wiki render -v
wiki render --check
wiki render --no-inference
wiki render --reload
wiki render --cache

Options

Flag Description
FILE... Optional .md paths; otherwise entire wiki (shell globs expand to multiple FILE args)
--check Dry-run; exit 1 if any block is stale
--no-inference Skip OWL-RL
--reload Rebuild graph before rendering
--cache Persist a warm graph under .wiki/cache/ for reuse across new processes
-v, --verbose Print update counts

Block format

See Style Guide for the sparql:start / sparql:end wrapper and fenced sparql code block. Close the start comment before the fence to show the query in built HTML; leave it open and close after the fence (<!-- sparql:start-->) to hide the query from published pages while wiki render still updates the table.

ContentsOn this page

[hide]

Backlinks