nihdoc

WIP markup parser (txt -> html)
git clone git://git.alexkarle.com.com/blag
Log | Files | Refs | README | LICENSE

nihdoc.1 (974B) [raw]


      1 .Dd December 18, 2021
      2 .Dt BLAG 1
      3 .Os
      4 .Sh NAME
      5 .Nm nihdoc
      6 .Nd convert plaintext to HTML
      7 .Sh SYNOPSIS
      8 .Nm nihdoc
      9 <
     10 .Ar in.txt
     11 >
     12 .Ar out.html
     13 .Sh DESCRIPTION
     14 .Nm
     15 is a very basic plaintext-to-HTML converter.
     16 It reads from stdin and writes to stdout so that it can
     17 .Xr pledge 2
     18 to only stdio.
     19 Any arguments given will produce an error.
     20 .Pp
     21 Like markdown, wrapped lines are supported,
     22 and a blank line is needed to start a new paragraph.
     23 .Pp
     24 The following markup is supported:
     25 .Pp
     26 .Bl -bullet -indent
     27 .It
     28 Inline *bold*, _italics_, `code` (bold/italics disabled in code)
     29 .It
     30 backslash to escape
     31 .It
     32 [alexkarle.com] bare links and [description](alexkarle.com)
     33 .It
     34 # headers (each # adds a level)
     35 .It
     36 Ordered and unordered lists via 1-9. and - respectively.
     37 Nesting supported only within the same type (no mixing, yet).
     38 .It
     39 Code blocks (start line with TAB)
     40 .It
     41 Block quotes (start line with >)
     42 .El
     43 .Sh SEE ALSO
     44 .Xr Markdown.pl 1 ,
     45 .Lk https://alexkarle.com/blog/mdoc-to-nihdoc.html