Crate rustextile

Rustextile is a parser of a popular Textile markup language written in stable Rust.

It is mostly a port of the “canonical” PHP Textile implementation and supports all of its markup features (as of php-textile v3.7.7), including

• Decorated text spans
• Images
• Tables
• Ordered/unordered lists
• Definition lists
• Complex quotations
• Code blocks
• CSS styles, classes and ID attributes
• Raw HTML inserts
• Footnotes and references
• “Restricted” parsing for untrusted user input
• Rendering in either XHTML or HTML5
• Extra safety perks to ensure nothing harmful can be sneaked into the output even without the use of restricted parsing.

Usage

Edit your Cargo.toml to include

[dependencies]
rustextile = "1"

Code Example

use rustextile::{Textile, HtmlKind};
use rustextile::ammonia::{UrlRelative, url::Url};

// Processing some ordinary Textile markup.
let textile = Textile::default()
    .set_html_kind(HtmlKind::XHTML);
let html = textile.parse("h1. It works!");
assert_eq!(html, "<h1>It works!</h1>");

// Raw HTML inserts are possible.
let html = textile.parse("<strong>Raw HTML insert</strong>");
assert_eq!(html, r#"<p><strong>Raw <span class="caps">HTML</span> insert</strong></p>"#);

// Forcing all links to have a specific "rel" attribute.
let textile = textile.set_rel(Some("nofollow"));
let html = textile.parse(r#"This "link":https://example.com/ won't be scanned by Google"#);
assert_eq!(html, r#"<p>This <a href="https://example.com/" rel="nofollow">link</a> won&#8217;t be scanned by Google</p>"#);

// The parser can be restricted from using advanced features (HTML inserts, CSS classes, etc.).
let textile = Textile::default().set_restricted(true);
let html = textile.parse("<div>Now raw HTML is restricted</div>");
assert_eq!(html, r#"<p>&lt;div&gt;Now raw <span class="caps">HTML</span> is restricted&lt;/div&gt;</p>"#);

// You can limit its capabilities to only paragraphs and blockquotes.
let textile = Textile::default().set_lite(true);
let html = textile.parse("h1. This *won't* become a header");
assert_eq!(html, r#"<p>h1. This <strong>won&#8217;t</strong> become a header</p>"#);

// Extra sanitation of the output through the Ammonia library.
let textile = Textile::default()
    .set_sanitize(true);
let html = textile.parse(r#"<script type="text/javascript">alert("Say hi!")</script>JS has been sanitized away!"#);
assert_eq!(html, "<p>JS has been sanitized away!</p>");

// This sanitation can be finely tuned to do exactly what you need.
let textile = textile.adjust_sanitizer(|sanitizer| {
    sanitizer
        .rm_tags(&["p", "del"])
        .url_relative(
            UrlRelative::RewriteWithBase(
                Url::parse("https://example.com").unwrap()))
});
let html = textile.parse(r#"Sanitizer -can also- be "tuned":/some-page/"#);
assert_eq!(html, r#"Sanitizer can also be <a href="https://example.com/some-page/">tuned</a>"#);

Re-exports

pub use ammonia;

Structs

Textile

The core structure responsible for converting Textile markup into HTML.

Enums

HtmlKind

Determines which flavor of HTML the Textile parser will produce. Check Textile::set_html_kind for details.