diff options
| author | 2024-09-01 14:24:40 -0500 | |
|---|---|---|
| committer | 2024-09-01 14:24:40 -0500 | |
| commit | 3908c222d5f284485e76da65793967f2ef04cca7 (patch) | |
| tree | d4c32b1247383de54aeba0836d7ac933ce6c88ef /doc | |
| parent | Title pages to match module name (diff) | |
Always have an h1 header on doc pages
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/api/argparse.mdz | 2 | ||||
| -rw-r--r-- | doc/api/build-rules.mdz | 2 | ||||
| -rw-r--r-- | doc/api/cc.mdz | 2 | ||||
| -rw-r--r-- | doc/api/channel.mdz | 2 | ||||
| -rw-r--r-- | doc/api/cjanet.mdz | 2 | ||||
| -rw-r--r-- | doc/api/cmath.mdz | 2 | ||||
| -rw-r--r-- | doc/api/crc.mdz | 2 | ||||
| -rw-r--r-- | doc/api/cron.mdz | 2 | ||||
| -rw-r--r-- | doc/api/data.mdz | 2 | ||||
| -rw-r--r-- | doc/api/ev-utils.mdz | 2 | ||||
| -rw-r--r-- | doc/api/fmt.mdz | 2 | ||||
| -rw-r--r-- | doc/api/getline.mdz | 2 | ||||
| -rw-r--r-- | doc/api/htmlgen.mdz | 2 | ||||
| -rw-r--r-- | doc/api/http.mdz | 2 | ||||
| -rw-r--r-- | doc/api/httpf.mdz | 2 | ||||
| -rw-r--r-- | doc/api/infix.mdz | 3 | ||||
| -rw-r--r-- | doc/api/math.mdz | 2 | ||||
| -rw-r--r-- | doc/api/mdz.mdz | 2 | ||||
| -rw-r--r-- | doc/api/misc.mdz | 2 | ||||
| -rw-r--r-- | doc/api/msg.mdz | 2 | ||||
| -rw-r--r-- | doc/api/path.mdz | 3 | ||||
| -rw-r--r-- | doc/api/randgen.mdz | 2 | ||||
| -rw-r--r-- | doc/api/regex.mdz | 2 | ||||
| -rw-r--r-- | doc/api/rpc.mdz | 3 | ||||
| -rw-r--r-- | doc/api/services.mdz | 3 | ||||
| -rw-r--r-- | doc/api/sh.mdz | 2 | ||||
| -rw-r--r-- | doc/api/stream.mdz | 2 | ||||
| -rw-r--r-- | doc/api/tasker.mdz | 2 | ||||
| -rw-r--r-- | doc/api/temple.mdz | 2 | ||||
| -rw-r--r-- | doc/api/test.mdz | 2 | ||||
| -rw-r--r-- | doc/api/zip.mdz | 2 |
31 files changed, 63 insertions, 3 deletions
diff --git a/doc/api/argparse.mdz b/doc/api/argparse.mdz index 5a51dec..be1d2d3 100644 --- a/doc/api/argparse.mdz +++ b/doc/api/argparse.mdz @@ -4,6 +4,8 @@ :template "mdzdoc/main.html"} --- +# Argparse + A moderately opinionated argument parser for @link[https://janet-lang.org][janet]. Use this for writing CLI scripts that need to have UNIX style switches and diff --git a/doc/api/build-rules.mdz b/doc/api/build-rules.mdz index f4f5073..663f8b8 100644 --- a/doc/api/build-rules.mdz +++ b/doc/api/build-rules.mdz @@ -2,6 +2,8 @@ :template "mdzdoc/main.html"} --- +# Build Rules + Run commands that produce files in an incremental manner. Use to implement a build system. diff --git a/doc/api/cc.mdz b/doc/api/cc.mdz index 6a5fd93..b2256bc 100644 --- a/doc/api/cc.mdz +++ b/doc/api/cc.mdz @@ -2,6 +2,8 @@ :template "mdzdoc/main.html"} --- +# CC + Improved version of the C Compiler abstraction from JPM that should be more correct, composable, and have less configuration. diff --git a/doc/api/channel.mdz b/doc/api/channel.mdz index 62ddf26..d1d01b7 100644 --- a/doc/api/channel.mdz +++ b/doc/api/channel.mdz @@ -2,6 +2,8 @@ :template "mdzdoc/main.html"} --- +# Channel Utilities + ## Reference @api-docs[../../spork/channel] diff --git a/doc/api/cjanet.mdz b/doc/api/cjanet.mdz index bf90cd1..59b5e0a 100644 --- a/doc/api/cjanet.mdz +++ b/doc/api/cjanet.mdz @@ -2,6 +2,8 @@ :template "mdzdoc/main.html"} --- +# CJanet + A DSL that compiles to C. Improved version of jpm/cgen that is more amenable to Janet integration, macros, and meta-programming. diff --git a/doc/api/cmath.mdz b/doc/api/cmath.mdz index 657d654..974f55f 100644 --- a/doc/api/cmath.mdz +++ b/doc/api/cmath.mdz @@ -2,6 +2,8 @@ :template "mdzdoc/main.html"} --- +# CMath + ## Reference @api-docs[../../build/spork/cmath] diff --git a/doc/api/crc.mdz b/doc/api/crc.mdz index 5d5b20d..75a2634 100644 --- a/doc/api/crc.mdz +++ b/doc/api/crc.mdz @@ -2,6 +2,8 @@ :template "mdzdoc/main.html"} --- + # Cyclic Redundancy Check (CRC) + Generate CRC variants. Rather than compile separate variants, we have code to generate the needed tables. Keeps build simple, footprint small but with many variants accessible. diff --git a/doc/api/cron.mdz b/doc/api/cron.mdz index 90d3b66..d368b59 100644 --- a/doc/api/cron.mdz +++ b/doc/api/cron.mdz @@ -2,6 +2,8 @@ :template "mdzdoc/main.html"} --- +# Cron + Timer library for interfacing with the UNIX crontab format. The cron format support is based on the unix cron syntax, with an optional diff --git a/doc/api/data.mdz b/doc/api/data.mdz index b36472e..3375ff5 100644 --- a/doc/api/data.mdz +++ b/doc/api/data.mdz @@ -4,6 +4,8 @@ :template "mdzdoc/main.html"} --- +# Data + @p{@link[https://clojure.org/]{Clojure} contains a very useful core library (or "namespace" in Clojure parlance) called @link[https://clojure.github.io/clojure/clojure.data-api.html]{clojure.data} (@link[https://github.com/clojure/clojure/blob/51c6d7a70912a8f65e81a8e11ae6f56c94920725/src/clj/clojure/data.clj]{source}). It contains one "exported" function: @code`clojure.data/diff`. This addition to spork, @code`data.janet`, should exactly replicate the behavior of @code`clojure.data/diff` using Janet tables, structs, arrays, and tuples in place of their Clojure equivalents.} ## Function diff --git a/doc/api/ev-utils.mdz b/doc/api/ev-utils.mdz index e0ed2af..63ae160 100644 --- a/doc/api/ev-utils.mdz +++ b/doc/api/ev-utils.mdz @@ -2,6 +2,8 @@ :template "mdzdoc/main.html"} --- +# Event Loop Utilities + Module for parallel execution utilities with Janet. ## Reference diff --git a/doc/api/fmt.mdz b/doc/api/fmt.mdz index dcd4f16..2b40f69 100644 --- a/doc/api/fmt.mdz +++ b/doc/api/fmt.mdz @@ -4,6 +4,8 @@ :template "mdzdoc/main.html"} --- +# Formatting + Provides a way to format Janet code strings and files. ## Strings diff --git a/doc/api/getline.mdz b/doc/api/getline.mdz index 3c85840..2db3d22 100644 --- a/doc/api/getline.mdz +++ b/doc/api/getline.mdz @@ -2,6 +2,8 @@ :template "mdzdoc/main.html"} --- +# Getline Utilities + Module for fiber-based sequence combinators rather than array-based combinators, as are in the core library. ## Reference diff --git a/doc/api/htmlgen.mdz b/doc/api/htmlgen.mdz index 6390ac7..90b5fbd 100644 --- a/doc/api/htmlgen.mdz +++ b/doc/api/htmlgen.mdz @@ -4,6 +4,8 @@ :template "mdzdoc/main.html"} --- +# HTML Gen + HTMLgen is a rendering engine that can render plain data structures into an HTML string. Its API has only one constant and two functions: diff --git a/doc/api/http.mdz b/doc/api/http.mdz index 2ceb90e..e507be9 100644 --- a/doc/api/http.mdz +++ b/doc/api/http.mdz @@ -4,6 +4,8 @@ :template "mdzdoc/main.html"} --- +# HTTP + The @code`http` module is an HTTP/1.1 parser, server and client module. It proves a simple server implementation, client, support for chunked encoding. The @code`http` module is also non-blocking, so a single thread can run many clients, servers, and connections at once. diff --git a/doc/api/httpf.mdz b/doc/api/httpf.mdz index 90ce05e..9dad96e 100644 --- a/doc/api/httpf.mdz +++ b/doc/api/httpf.mdz @@ -2,6 +2,8 @@ :template "mdzdoc/main.html"} --- +# HTTP Framework + A simple, opinionated HTTP framework for HTML, JDN, and JSON servers. Servers can easily be configured from defn bindings with appropriate metadata. diff --git a/doc/api/infix.mdz b/doc/api/infix.mdz index 373dfea..34bee36 100644 --- a/doc/api/infix.mdz +++ b/doc/api/infix.mdz @@ -3,6 +3,7 @@ --- # Infix + A macro for infix syntax in Janet. Useful for math. ## Examples @@ -35,4 +36,4 @@ Syntax is as follows: ## Reference -@api-docs[../../spork/infix] +@api-docs("../../spork" "infix") diff --git a/doc/api/math.mdz b/doc/api/math.mdz index 8e6fc80..b9988a9 100644 --- a/doc/api/math.mdz +++ b/doc/api/math.mdz @@ -4,6 +4,8 @@ :template "mdzdoc/main.html"} --- +# Math + The math module deals with two main areas of mathematics: statistics and linear algebra. diff --git a/doc/api/mdz.mdz b/doc/api/mdz.mdz index 1ff2cd5..9af4379 100644 --- a/doc/api/mdz.mdz +++ b/doc/api/mdz.mdz @@ -2,6 +2,8 @@ :template "mdzdoc/main.html"} --- +# Mendoza + Re-implementation of mendoza markup. Designed to work with htmlgen. ## Reference diff --git a/doc/api/misc.mdz b/doc/api/misc.mdz index 42f889c..b328821 100644 --- a/doc/api/misc.mdz +++ b/doc/api/misc.mdz @@ -4,6 +4,8 @@ :template "mdzdoc/main.html"} --- +# Miscellaneous Utilities + ## Dedent Remove indentation after concatenating the arguments. diff --git a/doc/api/msg.mdz b/doc/api/msg.mdz index 86cd641..daabfd8 100644 --- a/doc/api/msg.mdz +++ b/doc/api/msg.mdz @@ -4,6 +4,8 @@ :template "mdzdoc/main.html"} --- +# Messages + Provide a symmetric way to send and receive seqential messages over a networked stream. Useful for building more complicated application level protocols on top of TCP. diff --git a/doc/api/path.mdz b/doc/api/path.mdz index 1929a4a..52e5b46 100644 --- a/doc/api/path.mdz +++ b/doc/api/path.mdz @@ -3,6 +3,9 @@ :license "MIT" :template "mdzdoc/main.html"} --- + +# Path + Simple path manipulation module for Janet. Supports manipulation both windows and posix paths on any platform, and provides functions that work according to the current host platform. diff --git a/doc/api/randgen.mdz b/doc/api/randgen.mdz index 42ddfcf..08e3668 100644 --- a/doc/api/randgen.mdz +++ b/doc/api/randgen.mdz @@ -4,6 +4,8 @@ :template "mdzdoc/main.html"} --- +# Random Generator + A small utility for random number generation, especially with a focus on discrete numbers. The most powerful idea here is the ability to have branches that execute in a probabilistic manner - i.e. one branch is taken half the time diff --git a/doc/api/regex.mdz b/doc/api/regex.mdz index f78d691..777bc98 100644 --- a/doc/api/regex.mdz +++ b/doc/api/regex.mdz @@ -4,6 +4,8 @@ :template "mdzdoc/main.html"} --- +# Regex + A module for compiling a subset of regexes to Janet PEGs. All regex are considered to be anchored, and performance is is not going to be competitive with a native regex engine. diff --git a/doc/api/rpc.mdz b/doc/api/rpc.mdz index 666f7a2..b359626 100644 --- a/doc/api/rpc.mdz +++ b/doc/api/rpc.mdz @@ -4,8 +4,9 @@ :template "mdzdoc/main.html"} --- -A simple remote procedure call tool for Janet. +# Remote Procedure Calls +A simple remote procedure call tool for Janet. ## Server diff --git a/doc/api/services.mdz b/doc/api/services.mdz index 116ff3b..e86aa9f 100644 --- a/doc/api/services.mdz +++ b/doc/api/services.mdz @@ -1,7 +1,8 @@ -{:title "Services" +{:title "services" :template "mdzdoc/main.html"} --- +# Services Module for running a number of background processes in a controlled manner. Similar to ev-utils, but more involved with defaults for IO and naming fibers for debugging purposes. Services can also implicitly launch sibling or child services if needed. diff --git a/doc/api/sh.mdz b/doc/api/sh.mdz index a1428e4..9553084 100644 --- a/doc/api/sh.mdz +++ b/doc/api/sh.mdz @@ -2,6 +2,8 @@ :template "mdzdoc/main.html"} --- +# Shell Utilities + Shell utilities for Janet. ## Reference diff --git a/doc/api/stream.mdz b/doc/api/stream.mdz index 6bfa726..852a695 100644 --- a/doc/api/stream.mdz +++ b/doc/api/stream.mdz @@ -2,6 +2,8 @@ :template "mdzdoc/main.html"} --- +# Stream Utilities + Stream utilities for Janet. ## Reference diff --git a/doc/api/tasker.mdz b/doc/api/tasker.mdz index 04da951..e109ef3 100644 --- a/doc/api/tasker.mdz +++ b/doc/api/tasker.mdz @@ -2,6 +2,8 @@ :template "mdzdoc/main.html"} --- +# Tasker + A simple task executor library/server. ## Reference diff --git a/doc/api/temple.mdz b/doc/api/temple.mdz index c65e234..19bf356 100644 --- a/doc/api/temple.mdz +++ b/doc/api/temple.mdz @@ -4,6 +4,8 @@ :template "mdzdoc/main.html"} --- +# Temple + HTML templates for Janet. Simplified version of Mendoza's template system that is cleaner and diff --git a/doc/api/test.mdz b/doc/api/test.mdz index 99ab5d0..e5c5de9 100644 --- a/doc/api/test.mdz +++ b/doc/api/test.mdz @@ -4,6 +4,8 @@ :template "mdzdoc/main.html"} --- +# Test Utilities + This module contains a simple test helper when you do not need a specialized library. diff --git a/doc/api/zip.mdz b/doc/api/zip.mdz index 16e03b9..d8920bc 100644 --- a/doc/api/zip.mdz +++ b/doc/api/zip.mdz @@ -2,5 +2,7 @@ :template "mdzdoc/main.html"} --- +# Zip + Wrapper around miniz for compression functionality. |
