miki

Miki: personal wiki with the fmd markup format
git clone https://wtenison.com/repo/miki.git
Log | Files | Refs | README | LICENSE

legend.fmd (2435B)


      1 _(class:"--set-size_5-4-font"):{OVERVIEW}
      2 
      3 sup:{This is a info page for the b:{FMD interpreter}.}
      4 The b:{FMD interpreter} is being developed for the a(link:"https://test.wtenison.com/home"):{Miki Project} to provide a convenient Markdown language that is easy to parse, straightforward to read, and able to work with HTML. This is a application being developed for education and personal use. FMD runs on the browser via a WASM module.
      5 
      6 Using the b:{Text Pad} sup:{(click b:RETURN above if in b:OUTPUT view)}, you may input almost any character without stirring the ire of the interpreter. The symbols you need to look out are: code:{ : "{ }" ( )}
      7 
      8 FMD uses a simple expression form to execute operations: code:{OPERATOR-ID:OPERAND} or code:{OPERATOR-ID(PARAMS optional):OPERAND} For the purposes of this demonstration, I won't touch on the code:{PARAMS} much here (i:{for now}). They don't do much for most operations that needs to be known right now.
      9 
     10 col:{
     11     _:{sup:i:{Examples:}}
     12     _:{
     13         code:{ "i:car" } = code:{i:car} sm:{for single word operation.}
     14         code:{"b:{golden retriever lab}" } = code:{b:{golden retriever lab}} sm:{for operations on multiple words.}
     15         code:{"p:{test sentence}"} = code:{"p():{test sentence}" } sm:{when empty code:{()} are optional.}
     16 
     17         i:sm:{See default b:{Text Pad} content for use example. Refresh page if cleared.}
     18     }
     19 }
     20 
     21 _(class:"--set-size_5-4-font"):OPERATORS
     22 
     23 code:{_} : b:{Empty} - Creates an empty code:{div}.
     24 code:{p} : b:{Paragraph}
     25 code:{b} : b:{Bold}
     26 code:{st} : b:{Strong}
     27 code:{i} : b:{Italic}
     28 code:{em} : b:{Emphasize}
     29 code:{u} : b:{Underline}
     30 code:{s} : b:{Strikethrough}
     31 code:{stk} : b:{Strike}
     32 code:{del} : b:{Delete}
     33 code:{hi} : b:{Highlight}
     34 code:{sm} : b:{Shrink}
     35 code:{sub} : b:{Subscript}
     36 code:{sup} : b:{Superscript}
     37 code:{blk} : b:{Quoted}
     38 code:{span} : b:{Span}
     39 code:{code} : b:{Code}
     40 code:{pre} : b:{Preformatted}
     41 code:{ul} : b:{Unordered List}
     42 code:{ol} : b:{Ordered List}
     43 code:{li} : b:{List Item}
     44 code:{h(1-6)} : b:{Header 1 - 6}
     45 
     46 code:{a} : b:{Link} - Creates a link. 
     47 sm:i:{Example:} code:{"a(link:"https://info.wtenison.com"):{Some Guy's Website}"}
     48 
     49 code:{img} : b:{Image} - Creates an image link.
     50 sm:i:{Example:} code:{"img(link:"https://test.wtenison.com/my-image.png"):{My Image}"}
     51 
     52 code:{col} : b:{Column} - Creates a block that will contain column elements.
     53 sm:i:{Example:} code:{"col:{ _:{column A content} _:{column B content}}"}