badrihippo
/
guile-strickenmark
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update README with explanation on what/why this is/exists

This commit is contained in:
Badri Sunderarajan 2024-02-20 17:51:33 +05:30
parent 12ca100007
commit a9b1bca4ac
Signed by: badrihippo
GPG Key ID: 9F594532AD60DE03
1 changed files with 17 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -1,3 +1,20 @@
This is my fork of the [`guile-commonmark`](https://github.com/OrangeShark/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](http://commonmark.org/),