A Common Lisp utility which converts HTML into Markdown text
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs
examples
link-revealer
roswell
src
t
.gitignore
.travis.yml
ChangeLog.rst
README.rst
html2text-link-revealer.asd
html2text-test.asd
html2text.asd
tasks.py
version.lisp-expr

README.rst

html2text

https://travis-ci.org/40ants/html2text.svg?branch=master

WORK IN PROGRESS.

Reasoning

There is great html2text python library, but I didn't found a way how to convert HTML to Markdown from Common Lisp. And made this library.

Example:

CL-USER> (html2text:html2text "
<p>A paragraph
which can be <b>multiline</b> and <em>can contain other tags</em>.
</p>

<ul>
  <li>Lisp is a great language</li>
  <li>For the reason</li>
</ul>
")
"A paragraph which can be **multiline** and _can contain other tags_ .

* Lisp is a great language
* For the reason
"
CL-USER>

How to build documentation

To build documentation, you need a Sphinx. It is documentaion building tool written in Python.

To install it, you need a virtualenv. Read this instructions how to install it.

Also, you'll need a cl-launch. It is used by documentation tool to run a script which extracts documentation strings from lisp systems.

Run these commands to build documentation:

virtualenv --python python2.7 env
source env/bin/activate
pip install -r docs/requirements.txt
invoke build_docs

These commands will create a virtual environment and install some python libraries there. Command invoke build_docs will build documentation and upload it to the GitHub, by replacing the content of the gh-pages branch.

Authors

Copyright

Copyright (c) 2018 Alexander Artemenko (svetlyak.40wt@gmail.com)

License

Licensed under the BSD License.