barrylogen/markdown-image-replacer-frontend repository overview

⁠Markdown Image Replacer

⚡ A tool for replacing image links in Markdown files.

⁠Features

• Dual Modes
  • GitHub Mode: Upload to repo & update links
  • Local Mode: Download as ZIP
• Image Optimization: Optional TinyPNG compression

⁠Tech Stack

• Frontend: React + TypeScript
• Backend: Node.js + TypeScript
• Image: TinyPNG API (optional)

⁠Quick Start

⁠One-Click Installation

/bin/bash -c "$(curl -fsSL -H 'Accept: application/vnd.github.v3.raw' https://api.github.com/repos/hellojuantu/markdown-image-replacer/contents/docker/install_run.sh)"

Access：http://localhost:13001⁠

⁠One-Click Upgrade

/bin/bash -c "$(curl -fsSL -H 'Accept: application/vnd.github.v3.raw' https://api.github.com/repos/hellojuantu/markdown-image-replacer/contents/docker/upgrade.sh)"

⁠One-Click Uninstallation

/bin/bash -c "$(curl -fsSL -H 'Accept: application/vnd.github.v3.raw' https://api.github.com/repos/hellojuantu/markdown-image-replacer/contents/docker/uninstall.sh)"

⁠Usage Guide

1. Choose Mode

   • GitHub: Upload to repo
   • Local: Download ZIP

2. Process File

   • Upload Markdown file
   • Enable compression (optional)
   • Start processing

3. Get Results

   • GitHub: Copy updated Markdown
   • Local: Download ZIP

⁠Configuration

⁠GitHub Settings

If you choose to upload images and replace links using GitHub mode, you need to prepare a public repository and provide an access token. Below are the configuration fields and setup instructions:

⁠Required Fields

⁠Steps to Create a Repository and Token

1. Create a Repository

   • Visit https://github.com/new⁠
   • Enter a repository name, e.g., image-host
   • Choose Public
   • Click Create repository
   • Follow prompts to initialize with a branch (e.g., main)

2. Generate a GitHub Token

   • Go to https://github.com/settings/tokens⁠
   • Click Generate new token (classic)
   • Select the repo scope (including repo:status, repo_deployment, public_repo, repo:invite)
   • Copy the generated token (Note: it's shown only once, so store it securely)

3. Fill in the Configuration

   • On the tool page, enter the following:
     • Username: your GitHub account name
     • Repository: the name you just created, e.g., image-host
     • Branch: the initialized branch name, e.g., main
     • Token: paste the GitHub token you just copied

⁠Image Settings