clean-copy/server/templates/docs.html

{% extends "base.html" %}

{% block title %}Documentation — CleanCopy{% endblock %}

{% block head %}
<style>
  code {
    background: var(--color-border-subtle);
    padding: 0.15rem 0.4rem;
    border-radius: 4px;
    font-size: 0.9rem;
  }

  kbd {
    background: var(--color-border-subtle);
    border: 1px solid var(--color-border-muted);
    border-radius: 4px;
    padding: 0.1rem 0.4rem;
    font-size: 0.85rem;
    font-family: inherit;
  }

  .section {
    margin-bottom: 2.5rem;
  }
</style>
{% endblock %}

{% block content %}
<a class="back" href="/">← Home</a>
<h1>CleanCopy Documentation</h1>

<div class="section">
  <h2>What is CleanCopy?</h2>
  <p>
    CleanCopy is a lightweight clipboard cleaning tool for Windows. When
    triggered, it instantly sanitizes the text currently in your clipboard
    — stripping trackers, normalizing typography, and removing invisible
    characters.
  </p>
</div>

<div class="section">
  <h2>Installation</h2>
  <ol>
    <li>
      Complete your purchase on the
      <a href="/">homepage</a>.
    </li>
    <li>
      Check your receipt email for the download link and your payment ID.
    </li>
    <li>
      Download and run the installer. CleanCopy will start automatically.
    </li>
    <li>The CleanCopy icon will appear in your system tray.</li>
  </ol>
</div>

<div class="section">
  <h2>How to Use</h2>
  <p>
    Copy text to your clipboard as usual. When you're ready to clean it:
  </p>
  <ol>
    <li>
      Press <kbd>Ctrl</kbd> + <kbd>C</kbd> twice quickly (default
      shortcut).
    </li>
    <li>CleanCopy processes the clipboard text in place.</li>
    <li>Paste the cleaned text wherever you need it.</li>
  </ol>
  <p>
    That's it — there's no window to interact with. CleanCopy works
    silently in the background.
  </p>
</div>

<div class="section">
  <h2>What Gets Cleaned</h2>
  <ul>
    <li>
      <strong>Tracking parameters</strong> — Removes
      <code>utm_source</code>, <code>utm_medium</code>,
      <code>gclid</code>, <code>fbclid</code>, and other marketing
      trackers from URLs while preserving functional query parameters.
    </li>
    <li>
      <strong>Smart quotes &amp; dashes</strong> — Converts curly quotes
      (<code>" "</code> <code>' '</code>) to straight quotes and
      em/en-dashes to hyphens.
    </li>
    <li>
      <strong>Line breaks</strong> — Joins single-newline wraps from chat
      apps and emails into continuous lines, while preserving paragraph
      breaks.
    </li>
    <li>
      <strong>Invisible characters</strong> — Removes zero-width spaces,
      null bytes, and other invisible Unicode characters.
    </li>
  </ul>
</div>

<div class="section">
  <h2>Configuration</h2>
  <p>
    Open the settings window from the system tray icon or by pressing
    <kbd>Ctrl</kbd> + <kbd>C</kbd> while no text is selected. From there
    you can:
  </p>
  <ul>
    <li>Toggle individual cleaning rules on or off.</li>
    <li>Add custom URL tracking parameters to strip.</li>
    <li>Change the activation shortcut.</li>
  </ul>
</div>

<div class="section">
  <h2>Troubleshooting</h2>
  <ul>
    <li>
      <strong>Shortcut doesn't work</strong> — Another app may be using
      the same shortcut. Try changing it in Settings.
    </li>
    <li>
      <strong>CleanCopy won't start</strong> — Make sure it's not blocked
      by your antivirus. Add it to your allowlist if needed.
    </li>
    <li>
      <strong>License not activating</strong> — Ensure you have a stable
      internet connection and that your payment ID (starting with
      <code>pi_</code>) is correct.
    </li>
  </ul>
</div>
{% endblock %}