Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/swzzl-com/purell
Hand sanitizer for markup
https://github.com/swzzl-com/purell
Last synced: 3 days ago
JSON representation
Hand sanitizer for markup
- Host: GitHub
- URL: https://github.com/swzzl-com/purell
- Owner: swzzl-com
- License: other
- Created: 2019-04-16T16:59:01.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2023-05-12T10:38:12.000Z (over 1 year ago)
- Last Synced: 2024-12-28T20:39:18.646Z (27 days ago)
- Language: JavaScript
- Size: 372 KB
- Stars: 2
- Watchers: 4
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.markdown
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
# **DEPRECATED.**
THIS LIBRARY MIGHT STILL WORK FOR CERTAIN USE CASES BUT ISN'T BEING ACTIVELY DEVELOPED OR MAINTAINED ANYMORE.
# Purell — The Hand Santizer for HTML
Purell is used to extract clean HTML from any kind of flat file format and prepare it for conversion into a raw [Superbook](https://bubblin.io/docs/format). It is a `pure` CLI utility to turn low quality markup available off of ordinary files into a high-quality Superbook-compatible markdown as per Bubblin-approved standards.
### How to use
Purell is almost entirely designed to be used at the root of a [Bookiza](https://bookiza.io) app. However, it can also be used as a transitioning tool between older file formats and the Superbook format,like so:
1. MS Word ⭌ Extract ugly HTML ⭌ Markdown ⭌ Sanitized HTML ⭌ Superbook
2. ePub ⭌ Markdown ⭌ Sanitized HTML ⭌ Superbook
3. PDF ⭌ ⭌ Markdown ⭌ Sanitized HTML ⭌ Superbook
4. Webpage (Scroll) ⭌ Markdown ⭌ Sanitized HTML ⭌ Superbook
### Vocabulary
```
$ pure --help
$ pure fetch // Will fetch original.html from source URI
$ pure defile // Will extract original.html from source file.
$ pure sanitize // Markdown Compatible HTML (Sanitized)
```
The responsibility to paginate the `sanitized.html` into a Superbook is held by [h2s](https://github.com/bookiza/h2s).
### License
Blueoak Model License 1.0.0