Custom output formats

Open
#777 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Stale
Tech stack
javascript, jekyll
Domain
tooling

Research direction

The issue does not name files or tests. Start by reviewing the current .parse() output and how Readability assembles it, then compare the requested Markdown, LaTeX, HTML, virtual DOM, and existing object targets. Agree on the plugin boundary and acceptance criteria with maintainers before implementation.

Written by the indexing model from the issue text.

Description

feature-request

This is a very niche use case, but might it make sense to add it anyway.

I would like to use readability as a way of backing up external links that are referenced. If the external link dies, the link is updated to the archived version on my website (which uses Jekyll). However, I would like it to use my website's Jekyll formatting, which would require the file to be in markdown format.

Would it be possible to make readability pluggable so that custom output methods (such as a virtual DOM object, markdown, latex, pure HTML, or the object that .parse() currently returns) can be supported?

Dominant language
JavaScript
Stars
11.5k
Forks
732
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from mozilla/readability

All issues in mozilla/readability

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.