chickadee » gmi » gmi:read

(gmi:read #!optional (port (current-input-port)))procedure

This procedure can be used to read a Gemtext document. port determines where to read from and is optional (defaults to (current-input-port)).

The returned value is an object that may be accessed and manipulated with the gmi:* procedures documented below.

If the input file ends in the middle of a code block, everything up to, but not including, the code block will be returned. Additionally a string error message will be returned as the second value.