2013-12-17 22:56:18 +01:00
2014-01-09 11:49:22 +01:00
2013-12-17 22:41:08 +01:00
2013-12-17 22:41:08 +01:00
2014-01-09 11:53:09 +01:00
2013-12-17 22:41:08 +01:00
2014-01-09 11:53:09 +01:00

ReadSharp

ReadSharp was previously PocketSharp.Reader and is now hosted without the PocketSharp dependency.

Install ReadSharp using NuGet

Install-Package ReadSharp

What's it all about?

The library extracts the main content of a website and returns the article as HTML with it's associated title, description, favicon and all included images.

The content can be encapsulated in a <body>-Tag and displayed as a readable website with a custom CSS (it's up to you!).

ReadSharp is based on a custom PCL port of NReadability and SgmlReader, which are included in the solution.

Association with Pocket

This library is a replacement for the Article View API by Pocket which is limited by usage and privacy.

With ReadSharp you won't hit any usage limits, as you are extracting the content directly. And it's open source.


Example

using ReadSharp;

Reader reader = new Reader();
Article article;

try
{
  article = await reader.Read(new Uri("http://frontendplay.com/story/4/http-caching-demystified-part-2-implementation"));
}
catch (ReadException exc)
{
  // handle exception
}

Article Model

The Article contains following fields:

  • string Title (the title of the page)
  • string Description (description of the page, extracted from meta information)
  • string Content (contains the article)
  • Uri FrontImage (main page image extracted from meta tags like apple-touch-icon and others)
  • Uri Favicon (the favicon of the page)
  • List<ArticleImage> Images (contains all images found in the text)
  • string NextPage (contains the next page URI, if available)

Article Image

  • Uri Uri
  • string Title (extracted from the title attribute)
  • string AlternativeText (extracted from the alt attribute)

Supported platforms

ReadSharp is a Portable Class Library, therefore it's compatible with multiple platforms:

  • .NET >= 4.0.3 (including WPF)
  • Silverlight >= 4
  • Windows Phone >= 7.5
  • Windows Store

Forked Dependencies

forks are included in the primary source code

Contributors

ceee
ceee

License

MIT License

S
Description
🐓 Extract meaningful website contents using a port of NReadability
Readme 1.3 MiB
Languages
C# 99.4%
CSS 0.6%