simple-learning

Simple learning web program
git clone git://git.laack.co/simple-learning.git
Log | Files | Refs | README | LICENSE

sl.sl (1173B)

      1 # Simple Learning Format (.sl)
      2 
      3 ## Purpose
      4 
      5 The simple learning file format is intended to be a minimal but sufficient file format for the distribution of learning content. While not a superset of gemtext, sl is inspired by the syntax and ethos of the format. 
      6 
      7 => https://geminiprotocol.net/docs/gemtext-specification.gmi
      8 
      9 ## Specifics
     10 
     11 A parser of sl files must track one bit of state: whether the current line is contained within a preformatted text block or not. Preformatted text blocks are delimited by lines that contain precisely three ` characters, and no other characters, new line character excluded. Such blocks may be used for code or other text that requires monospace alignment, such as ASCII art.
     12 
     13 Outside of preformatted blocks, there are eight line types:
     14 
     15 * Text lines
     16 * Embedded link lines
     17 * Heading lines
     18 * Hidden Lines
     19 * Quote lines
     20 * Text link lines
     21 * List items
     22 
     23 While links could've be combined into one category, building alternative parsers and frontends is made much simpler by requiring users to specify what type of content they are linking to. By doing this, instructors can choose to link to external videos, or have them rendered in line.