ReKoPub/site/index.html

<!doctype html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <meta name="viewport" content="width=device-width, initial-scale=1">
  <title>ReKoPub: web articles as e-ink EPUBs</title>
  <meta name="description" content="ReKoPub is a small command-line tool that turns a web article into a clean EPUB for the reMarkable 2 and Kobo Clara HD.">
  <meta name="color-scheme" content="light dark">
  <link rel="canonical" href="https://rekopub.monoexp.com/">
  <link rel="icon" href="/favicon.svg" type="image/svg+xml">
  <link rel="stylesheet" href="/style.css">
</head>
<body>
  <!--
    Published by the monoexp.com pipeline on every merge into main. It fills
    in the version, commit and date placeholders below and builds the files
    in /download/ (see "Releasing" in README.md).
  -->
  <header class="site-header">
    <div class="wrap header-inner">
      <a class="wordmark" href="/">reko<span>pub</span></a>
      <nav aria-label="Main">
        <a href="#download">Download</a>
        <a href="#usage">Usage</a>
        <a href="https://git.monoexp.com/bajdev/ReKoPub">Source</a>
      </nav>
    </div>
  </header>

  <main class="wrap">
    <section class="about" aria-labelledby="about-title">
      <h1 id="about-title">ReKoPub</h1>
      <p class="lede">Turn any web article into a clean EPUB for your e-ink reader.</p>
      <p>
        ReKoPub is a small command-line tool. You give it a URL. It downloads
        the page, keeps the article itself (dropping navigation, ads, pop-ups
        and comments) and writes an EPUB tuned for grayscale e-ink screens.
        It is built for the <strong>reMarkable 2</strong> and the
        <strong>Kobo Clara HD</strong>.
      </p>
      <pre><code>rekopub -URL https://example.com/some-article -SAVE ~/Books/</code></pre>
    </section>

    <section id="convert" aria-labelledby="convert-title">
      <h2 id="convert-title">Convert an article</h2>
      <div class="convert">
        <!-- Sent to rekopub-web (cmd/rekopub-web), which runs the rekopub
             command on the server. convert.js shows the result on this page;
             without JavaScript the server answers with a page of its own. -->
        <form id="convert-form" action="/api/convert" method="post">
          <fieldset id="convert-fields">
            <label for="convert-url">Article address</label>
            <div class="convert-row">
              <input id="convert-url" name="url" type="url" required maxlength="2000"
                     placeholder="https://example.com/some-article" autocomplete="url" spellcheck="false">
              <button type="submit">Convert</button>
            </div>
            <fieldset class="formats">
              <legend>Format</legend>
              <label><input type="radio" name="format" value="epub" checked> EPUB <span>reMarkable and most readers</span></label>
              <label><input type="radio" name="format" value="kepub"> KEPUB <span>Kobo</span></label>
              <label><input type="radio" name="format" value="both"> Both</label>
            </fieldset>
          </fieldset>
        </form>
        <div id="convert-result" class="convert-result" role="status" aria-live="polite"></div>
        <p class="small">
          This server downloads the page and makes the book for you, with the
          same rules as the command-line tool. Books are deleted after
          <span id="keep-hours">24</span> hours. It's shared by everyone, so
          conversions are limited and may be paused for a while when it's busy.
        </p>
      </div>
    </section>

    <section id="features" aria-labelledby="features-title">
      <h2 id="features-title">Features</h2>
      <ul class="cards">
        <li class="card">
          <h3>Readable content only</h3>
          <p>Finds the main article text. Menus, ads, cookie banners, share buttons and comments are left out.</p>
        </li>
        <li class="card">
          <h3>Tuned for e-ink</h3>
          <p>Images become grayscale and fit the screen, diagrams stay crisp, and fonts and margins are left to your reader.</p>
        </li>
        <li class="card">
          <h3>Works offline</h3>
          <p>Images are embedded in the book. Title, author, date and language are filled in, and every book gets a cover.</p>
        </li>
        <li class="card">
          <h3>Kobo-optimised</h3>
          <p><code>-KEPUB</code> writes a <code>.kepub.epub</code>, which Kobo opens with its faster renderer and reading stats.</p>
        </li>
        <li class="card">
          <h3>Safe saving</h3>
          <p>Never overwrites a file unless you pass <code>-FORCE</code>, and never leaves a half-written book behind.</p>
        </li>
        <li class="card">
          <h3>Single binary</h3>
          <p>No runtime dependencies. One file for Linux, macOS or Windows; nothing to install.</p>
        </li>
      </ul>
    </section>

    <section id="get" class="group" aria-labelledby="get-title">
      <h2 id="get-title" class="section-title">Download / Use ReKoPub</h2>

      <section id="download" aria-labelledby="download-title">
        <h3 id="download-title" class="label">Download</h3>
        <div class="release">
          <p class="release-version">
            <strong>@VERSION@</strong>
            <span>built @DATE@ from commit
            <a href="https://git.monoexp.com/bajdev/ReKoPub/commit/@COMMIT@"><code>@SHORT@</code></a></span>
          </p>
          <table class="downloads">
            <thead>
              <tr><th scope="col">Computer</th><th scope="col">File</th></tr>
            </thead>
            <tbody>
              <tr><td>Windows (most PCs)</td><td><a href="/download/rekopub_windows_amd64.zip">rekopub_windows_amd64.zip</a></td></tr>
              <tr><td>Windows on Arm</td><td><a href="/download/rekopub_windows_arm64.zip">rekopub_windows_arm64.zip</a></td></tr>
              <tr><td>Mac with Apple silicon</td><td><a href="/download/rekopub_darwin_arm64.tar.gz">rekopub_darwin_arm64.tar.gz</a></td></tr>
              <tr><td>Mac with Intel</td><td><a href="/download/rekopub_darwin_amd64.tar.gz">rekopub_darwin_amd64.tar.gz</a></td></tr>
              <tr><td>Linux (x86-64)</td><td><a href="/download/rekopub_linux_amd64.tar.gz">rekopub_linux_amd64.tar.gz</a></td></tr>
              <tr><td>Linux (Arm)</td><td><a href="/download/rekopub_linux_arm64.tar.gz">rekopub_linux_arm64.tar.gz</a></td></tr>
            </tbody>
          </table>
          <p class="small"><a href="/download/checksums.txt">checksums.txt</a> lists the SHA-256 of each file.</p>
        </div>
        <p>
          Unpack the archive and put <code>rekopub</code> (<code>rekopub.exe</code>
          on Windows) somewhere convenient. It's a command-line program, so run it
          from Terminal, Command Prompt or PowerShell rather than by double-clicking.
          The binaries aren't code-signed, so the first run may show a warning:
        </p>
        <ul>
          <li><strong>Windows:</strong> SmartScreen may say "Windows protected your PC". Choose <em>More info &rarr; Run anyway</em>.</li>
          <li><strong>macOS:</strong> Gatekeeper may refuse to open it. Run this once, in the folder where you unpacked it:
            <pre><code>xattr -d com.apple.quarantine rekopub</code></pre></li>
        </ul>
        <p>With Go 1.26 or newer you can also build it yourself:</p>
        <pre><code>go install git.monoexp.com/bajdev/rekopub/cmd/rekopub@latest</code></pre>
      </section>

      <section id="usage" aria-labelledby="usage-title">
        <h3 id="usage-title" class="label">Usage</h3>
        <pre><code>rekopub -URL &lt;url&gt; -SAVE &lt;path&gt; [-FORCE] [-KEPUB]
rekopub -VERSION</code></pre>
        <div class="table-scroll">
          <table>
            <thead>
              <tr><th scope="col">Flag</th><th scope="col">What it does</th></tr>
            </thead>
            <tbody>
              <tr><td><code>-URL</code></td><td>The web page to convert. Must start with <code>http://</code> or <code>https://</code>. Required.</td></tr>
              <tr><td><code>-SAVE</code></td><td>Where to write the book: a file or a folder. Missing folders are created. Required.</td></tr>
              <tr><td><code>-FORCE</code></td><td>Overwrite the output file if it already exists.</td></tr>
              <tr><td><code>-KEPUB</code></td><td>Write a Kobo KEPUB (<code>.kepub.epub</code>) instead of a plain EPUB.</td></tr>
              <tr><td><code>-VERSION</code></td><td>Print the version and exit.</td></tr>
            </tbody>
          </table>
        </div>
        <p>Flag names are case-sensitive: <code>-URL</code> works, <code>-url</code> does not.</p>

        <h4>Where the book is saved</h4>
        <ul>
          <li><strong>A folder</strong>, such as <code>~/Books/</code> or an existing <code>~/Books</code>: the file name comes from the article title.</li>
          <li><strong>A path ending in <code>.epub</code></strong>: written to exactly that file.</li>
          <li><strong>Anything else</strong>, such as <code>~/Books/a</code>: treated as a file name, with <code>.epub</code> added.</li>
        </ul>
        <p>
          Watch the trailing slash when the folder doesn't exist yet:
          <code>-SAVE ~/Books/new/</code> creates a folder called <code>new</code>,
          while <code>-SAVE ~/Books/new</code> writes <code>new.epub</code>.
          On success, the saved file's full path is printed, so it's easy to use in scripts.
        </p>

        <h4>Kobo Clara HD</h4>
        <p>Use <code>-KEPUB</code> for faster page turns and reading stats. Connect the Kobo by USB, tap <em>Connect</em>, and save straight to it:</p>
        <pre><code># Linux
rekopub -URL https://example.com/article -SAVE /media/$USER/KOBOeReader/Articles/ -KEPUB
# macOS
rekopub -URL https://example.com/article -SAVE /Volumes/KOBOeReader/Articles/ -KEPUB
# Windows (the drive letter may differ)
rekopub.exe -URL https://example.com/article -SAVE E:\Articles\ -KEPUB</code></pre>
        <p>Eject the Kobo and the article appears in your library.</p>

        <h4>reMarkable 2</h4>
        <p>Use a plain EPUB, without <code>-KEPUB</code>. Save it on your computer:</p>
        <pre><code>rekopub -URL https://example.com/article -SAVE ~/reMarkable/</code></pre>
        <p>
          Then drag the file into the reMarkable desktop or mobile app, or upload it
          through the USB web interface (<em>Settings &rarr; Storage &rarr; USB web
          interface</em>, then open <code>http://10.11.99.1</code>).
        </p>

        <h4>Good to know</h4>
        <ul>
          <li>Pages that build their content with JavaScript, paywalls and cookie walls can't be converted.</li>
          <li>ReKoPub only reads web pages: it never reads files on your computer, and pages on the internet can't make it connect to your own network.</li>
          <li>It sends no cookies, never logs in and runs no JavaScript. Every book records its source URL.</li>
        </ul>
        <p>
          The <a href="https://git.monoexp.com/bajdev/ReKoPub#readme">README</a> has
          the full details: exit codes, troubleshooting and privacy.
        </p>
      </section>
    </section>

    <section id="license" aria-labelledby="license-title">
      <h2 id="license-title">License</h2>
      <p>
        ReKoPub is free software, released under the
        <a href="https://git.monoexp.com/bajdev/ReKoPub/src/main/LICENSE">MIT License</a>.
        Copyright &copy; 2026 bajdev.
      </p>
      <p>It builds on these open-source Go libraries:</p>
      <div class="table-scroll">
        <table class="libraries">
          <thead>
            <tr><th scope="col">Library</th><th scope="col">Used for</th><th scope="col">License</th></tr>
          </thead>
          <tbody>
            <tr><td><a href="https://github.com/markusmobius/go-trafilatura">go-trafilatura</a></td><td>Article and metadata extraction</td><td>Apache-2.0</td></tr>
            <tr><td><a href="https://github.com/go-shiori/go-epub">go-epub</a></td><td>EPUB packaging</td><td>MIT</td></tr>
            <tr><td><a href="https://github.com/pgaskin/kepubify">kepubify</a></td><td>KEPUB conversion</td><td>MIT</td></tr>
            <tr><td><a href="https://github.com/microcosm-cc/bluemonday">bluemonday</a></td><td>HTML sanitising</td><td>BSD-3-Clause</td></tr>
            <tr><td><a href="https://github.com/srwiley/oksvg">oksvg</a> and <a href="https://github.com/srwiley/rasterx">rasterx</a></td><td>SVG rendering</td><td>BSD-3-Clause</td></tr>
            <tr><td><a href="https://github.com/vincent-petithory/dataurl">dataurl</a></td><td>Images embedded in pages</td><td>MIT</td></tr>
            <tr><td><a href="https://github.com/google/uuid">uuid</a></td><td>Book identifiers</td><td>BSD-3-Clause</td></tr>
            <tr><td><a href="https://pkg.go.dev/golang.org/x/image">x/image</a>, <a href="https://pkg.go.dev/golang.org/x/net">x/net</a>, <a href="https://pkg.go.dev/golang.org/x/text">x/text</a>, <a href="https://pkg.go.dev/golang.org/x/sync">x/sync</a></td><td>WebP decoding, image scaling, cover fonts, HTML parsing, character sets</td><td>BSD-3-Clause</td></tr>
          </tbody>
        </table>
      </div>
    </section>
  </main>

  <footer class="site-footer">
    <div class="wrap">
      <p>A <a href="https://monoexp.com/">Mono Experiments</a> project &middot; <a href="https://git.monoexp.com/bajdev/ReKoPub">Source</a></p>
    </div>
  </footer>
  <script src="/convert.js" defer></script>
</body>
</html>