https://github.com/Ruzzie/Textorizer

Sanitize and 'clean' html for safe consumption in a plain text format.
https://github.com/Ruzzie/Textorizer

html plain-text sanitize sanitize-html text

Last synced: about 1 month ago
JSON representation

Sanitize and 'clean' html for safe consumption in a plain text format.

• Host: GitHub
• URL: https://github.com/Ruzzie/Textorizer
• Owner: Ruzzie
• License: other
• Created: 2020-10-10T10:52:22.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2024-03-08T06:57:22.000Z (9 months ago)
• Last Synced: 2024-10-13T19:35:36.351Z (about 2 months ago)
• Topics: html, plain-text, sanitize, sanitize-html, text
• Language: C#
• Homepage:
• Size: 111 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• project-awesome - Ruzzie/Textorizer - Sanitize and 'clean' html for safe consumption in a plain text format. (C# #)

README

        
# Textorizer

[![Build status](https://ci.appveyor.com/api/projects/status/rsvw865mti05iulv?svg=true)](https://ci.appveyor.com/project/Ruzzie/textorizer)

[![Nuget](https://img.shields.io/nuget/v/Textorizer)](https://www.nuget.org/packages/Textorizer)

Sanitize and 'clean' html for safe consumption in a plain text format.

```csharp

  var plainText = Textorize.HtmlToPlainText("I contain html
convert me
");

  //  plaintext = "I contain html\nconvert me\n"  

```

Converts html input to a safe plain text representation without html. 

Content in Style and Script tags are completely removed, html entity characters are explicitly converted to their unicode characters.

Invalid html is handled best effort for a reasonable equivalent plain text output.


Keep in mind the following equivalence:

        

    Textorize(input) == Textorize(HtmlEncode(Textorize(input)))

For more examples see the [testsuite](https://github.com/Ruzzie/Textorizer/blob/ae0577ed07f930759a1796bb877cd31884fe6709/source/Textorizer.UnitTests/HtmlTextorizerTests.cs#L12) 

## Install

### Package Manager Console

```

PM> Install-Package Textorizer

```

### .NET CLI Console

```

> dotnet add package Textorizer

```

## License

Dual licensed

MIT

https://opensource.org/licenses/MIT

Unlicense

https://opensource.org/licenses/Unlicense