Skip to content

Standard library

import { CardGrid, LinkCard, Card, Aside } from ‘@astrojs/starlight/components’;

The Sysl standard library lives at trisc/std/. Every module is a .lsysl literate file — Markdown prose interleaved with indented Sysl code blocks. The prose is real documentation; the code compiles identically to a .sysl file.

If you have the repo checked out, the files themselves are the reference. The pages here are a guide to what exists and what each module is for.

Every standard library module is a literate file. Open it in your editor and you get the implementation; render it with sysl doc and you get a documentation page. The prose is the spec.

Terminal window
# Render one file to HTML.
sysl doc std/regex/regex.lsysl
# Render an entire module directory.
sysl doc std/crypto/

That’s exactly how this site is rendered, too — the documentation you’re reading is the docs/ sibling to the library source.

The next few modules on the roadmap: std.tls (TLS 1.3 record layer), std.net (socket primitives on top of SLIX’s tcp/udp servers), and std.json (a streaming JSON parser/generator).