Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/matteocontrini/textify
HTML to plaintext conversion library (C#/.NET Standard 2.0)
https://github.com/matteocontrini/textify
csharp dotnet dotnet-standard html plaintext textify
Last synced: about 1 month ago
JSON representation
HTML to plaintext conversion library (C#/.NET Standard 2.0)
- Host: GitHub
- URL: https://github.com/matteocontrini/textify
- Owner: matteocontrini
- License: mit
- Created: 2019-11-25T21:21:41.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2022-08-28T16:52:25.000Z (over 2 years ago)
- Last Synced: 2024-12-01T12:52:43.478Z (about 1 month ago)
- Topics: csharp, dotnet, dotnet-standard, html, plaintext, textify
- Language: C#
- Homepage:
- Size: 50.8 KB
- Stars: 17
- Watchers: 3
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Textify
[](https://github.com/matteocontrini/Textify/actions) [](https://codecov.io/gh/matteocontrini/Textify) [](https://www.nuget.org/packages/Textify) [](https://github.com/matteocontrini/Textify/blob/master/LICENSE)
An HTML to plaintext conversion library for **.NET Standard 2.0** written in C#.
## Features
- Supports HTML **headings, paragraphs, containers, lists and tables** (basic support)
- Takes an **HTML string** as an input or an `INode` from [AngleSharp](https://github.com/AngleSharp/AngleSharp)
- Outputs a readable text representation of the web page
- Targets **.NET Standard 2.0**
- **Full test coverage**
## Installation
Install [from NuGet](https://www.nuget.org/packages/Textift/):
```powershell
Install-Package Textify
```
or
```powershell
dotnet add package Textify
```
## Usage
```csharp
HtmlToTextConverter converter = new HtmlToTextConverter();
string output = converter.Convert(html);
```
By default, the whole page will be converted.
If you're interested in converting only a part of it, parse the page by yourself with AngleSharp and pass the `INode` you're interested in. You don't need to install AngleSharp because Textify already depends on it.
```csharp
HtmlParser parser = new HtmlParser();
IHtmlDocument doc = parser.ParseDocument(html);
IElement element = doc.QuerySelector("#main");
HtmlToTextConverter converter = new HtmlToTextConverter();
string output = converter.Convert(element);
```
## Example
**Input:**
```html
Site title
Article title
Lorem ipsum dolor sit amet, consectetur adipiscing elit,
sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
Ut enim ad minim veniam, quis nostrud exercitation ullamco
laboris nisi ut aliquip ex ea commodo consequat.
Here is a list of things anyway:
- One
- Two
- Three
But maybe a table is nicer:
Key
Value
One
Value
```
Output:
```
[IMG: Logo] [1]
++++++++++
Site title
++++++++++
-------------
Article title
-------------
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
Here is a list of things anyway:
* One
* Two
* Three
But maybe a table is nicer:
| Key | Value |
| One | Value |
[1] http://example.com
```
## License
MIT license.
Thanks to Jay Taylor for the inspiration with his [html2text](https://github.com/jaytaylor/html2text) Go module.