Documentation
jacket doc builds API documentation as a static website, like this one. jacket doc covers the [doc] settings and themes.
Build the standard library's API documentation as a static website
jacket doc [OPTIONS] [PATH] [-- <FLAGS>...]
Arguments
| Argument | Meaning |
|---|---|
[PATH] | A library to document: a module (a folder with module.jai) or a folder of modules. Settings come from [doc] in its jacket.toml [default: [doc] path of the nearest jacket.toml, else the standard library] |
[FLAGS]... | Flags for jaic, after --: every compiler run of the build takes them, after the project's own (-import_dir is the useful one) |
Options
| Option | Meaning |
|---|---|
--site-url <URL> | Canonical site origin, over [doc] url |
--og-image <IMAGE> | Social preview image URL or file, over [doc] og_image |
--out <DIR> | Where to write the site [default: target/doc-site] |
--emit-input <DIR> | Also write the resolved JSON view model (including with --check) |
--theme <DIR> | Theme source overrides, over [doc] theme; relative to the current directory |
--timings | Print time spent building models, views, compiling the theme, rendering and writing |
--base-url <PATH> | The path the site is served under, with the slashes around it (/docs/jacket/) [default: /] |
--name <NAME> | The name in the header and page titles, over [doc] name [default: the folder's name] |
--version <VERSION> | The version shown in the header [default: none] |
--logo <FILE> | An SVG or PNG for the header and the page icon, over [doc] logo [default: none] |
--icon <FILE> | An SVG or PNG for the page icon alone, over [doc] icon [default: the logo] |
--repo <URL> | The repository's web address, over [doc] repo; Source links go to <URL>/blob/<ref>/<file> [default: none, and no Source links] |
--runtime <DIR> | A folder with jai_wasm.wasm and engine.mjs (a browser bundle) to copy into the site, so the Run buttons work; without it they are shown disabled. The examples are then tested in that compiler under Node (standard library only; an error without node) |
--playground-url <URL> | Where "open in playground" and the Playground link go, over [doc] playground [default: none, and no links] |
--source-ref <REF> | The tag, branch or commit Source links point at [default: the checkout's commit] |
--module <NAME> | Document only these modules (String, Extensions/Http); repeatable |
--check | Build and check the links without writing the site or running the examples |
--no-test-examples | Don't run the examples. By default each one with a Run button is run the way the browser runs it (WebAssembly target), and the build fails when one fails |
--allow-broken-links | Report broken intra-doc links as warnings instead of failing |
-h, --help | Print help |