The guile-commonmark Markdown parser, but with ~strikethrough~ support!
Go to file
Badri Sunderarajan a9b1bca4ac
Update README with explanation on what/why this is/exists
2024-02-20 17:51:33 +05:30
build-aux Use new test-driver for running tests 2017-05-20 16:57:42 -04:00
commonmark Add support for ~strike-through~ text! 2024-02-20 16:52:55 +05:30
doc Add texinfo documentation skeleton 2018-04-21 19:48:26 -04:00
m4 update support for Guile 3.0 2020-04-10 07:23:36 -04:00
scripts Add gcmark.in 2017-08-30 20:57:34 -04:00
tests fix list item with multi-blank lines 2020-04-29 22:21:12 -04:00
.gitignore setup testing with 'make check' 2015-12-22 19:07:08 -05:00
.travis.yml add print of test-suite.log 2015-12-25 15:46:59 -05:00
COPYING add license 2015-11-29 23:01:24 -05:00
COPYING.LESSER add license 2015-11-29 23:01:24 -05:00
Makefile.am Add texinfo documentation skeleton 2018-04-21 19:48:26 -04:00
NEWS fix nonportable regular expression control character ranges 2019-02-07 10:44:18 -05:00
README.md Update README with explanation on what/why this is/exists 2024-02-20 17:51:33 +05:30
bootstrap initial commit 2015-11-23 14:04:30 -05:00
commonmark.scm move commonmark->sxml to commonmark sxml module 2020-04-06 15:40:23 -04:00
configure.ac update support for Guile 3.0 2020-04-10 07:23:36 -04:00
guile.am fix autotools files for installation and distribution 2017-11-23 20:58:24 -05:00
guix.scm update support for Guile 3.0 2020-04-10 07:23:36 -04:00
pre-inst-env.in initial commit 2015-11-23 14:04:30 -05:00

README.md

This is my fork of the guile-commonmark library, adding support for ~strikethrough~ text. It's mainly for use on my blog, but you're free to reuse it as you see fit!

Note that this package clashes with the original guile-commonmark, so you should uninstall that before installing this. Also, I haven't done any of the Guix stuff (no idea how it works; help appreciated!).

Also note that strikethrough text is not part of the official CommonMark spec, although it is popular in other Markdown implementations. This package unfortunately doesn't (yet) support adding raw HTML entities like <del/>, or I'd have gone with that for my blog instead of creating a whole new repo!

The original guile-commonmark README follows.

guile-commonmark

guile-commonmark is a library for parsing CommonMark, a fully specified variant of Markdown.

Example

(use-modules (commonmark sxml)
             (sxml simple))

(define doc
  "A CommonMark document
=============

1. here is a list
2. with another item

    this is some code

A regular paragraph")

;; Parses the CommonMark.
(define doc-sxml (commonmark->sxml doc))

;; Writes to the current output port
(sxml->xml doc-sxml)

Requirements

Installation

Download the latest tarball and run:

./configure
make
sudo make install

This will install guile-commonmark with the prefix /usr/local/. This is not in the default load path for GNU Guile. You may choose to change the prefix to your GNU Guile's location with ./configure --prefix=/usr or add /usr/local/ to GNU Guile's load path in your .profile or .bash_profile like this (replacing 2.2 with your GNU Guile version):

export GUILE_LOAD_PATH="/usr/local/share/guile/site/2.2${GUILE_LOAD_PATH:+:}$GUILE_LOAD_PATH"
export GUILE_LOAD_COMPILED_PATH="/usr/local/lib/guile/2.2/site-ccache${GUILE_LOAD_COMPILED_PATH:+:}$GUILE_COMPILED_LOAD_PATH"

To build from git requires Autoconf and Automake.

./bootstrap
./configure
make
make install

To install from a recent version of git using Guix.

guix package -f guix.scm

License

LGPLv3 or later. See COPYING.LESSER and COPYING