Markdown To Scribble🔗 i

Shawn Wagner <shawnw.mobile@gmail.com>

Convert markdown into scribble document format. Most CommonMark elements are supported, except for html blocks and inline html.

1API🔗 i

(require commonmark/render/scribble )

package: markdown-to-scribble

procedure
( document->scribble doc
[ #:titletitle
#:authorauthor
#:author-emailauthor-email]) → string?
doc:document?
title:(or/cstring? #f)=#f
author:(or/cstring? #f)=#f
author-email:(or/cstring? #f)=#f

Convert a parsed Markdown document to a corresponding Scribble document.

If a title isn’t provided, the first level-1 heading (if any) in the document is used.

procedure
( write-scribble doc
[ out
#:titletitle
#:authorauthor
#:author-emailauthor-email]) → void?
doc:document?
out:output-port? =(current-output-port )
title:(or/cstring? #f)=#f
author:(or/cstring? #f)=#f
author-email:(or/cstring? #f)=#f

Write out the Scribble document corresponding to the parsed Markdown document to the given port.

If a title isn’t provided, the first level-1 heading (if any) in the document is used.

parameter
( scribble-lang )→string?
(scribble-lang lang)→void?
lang:string?

= "base"

The Scribble language to use for the output. A scribble/ is automatically prepended if it matches one of the standard Scribble sublanguages, (("base""manual""book""report""sigplan""acmart""jfp""lncs")) so the default "base" becomes #lang scribble/base and so on. Other values are included directly without a prefix.

2Command-line utility🔗 i

The package also installs a command line program to convert files called md2scrbl. It reads markdown specified either by a filename given on the command line or data read from standard input, and writes to standard output.

Run it with --help to see available options to specify fields like title and author.

top ← prev up next →