Skip to main content

A Python tool to fix broken Markdown links in files

Project description

Feathercarver

Feathercarver is a Python tool designed to fix broken Markdown links in files. It can handle various types of Markdown links, including those with titles, and can process multiple files at once.

Features

  • Fixes broken Markdown links split across multiple lines
  • Preserves code blocks and inline code
  • Handles links with titles (both single and double quotes)
  • Processes multiple files in a single run
  • Maintains the original file structure and content outside of links

Installation

To install Feathercarver, you can use pip:

pip install feathercarver

Usage

You can use Feathercarver from the command line:

feathercarver file1.md file2.md file3.md

This will process all the specified Markdown files, fixing any broken links it finds.

Development

To set up the development environment:

  1. Clone the repository:

    git clone https://github.com/gkwa/feathercarver.git
    cd feathercarver
    
  2. Install dependencies:

    rye sync
    . .venv/bin/activate
    
  3. Run tests:

    pytest
    

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

feathercarver-0.1.16.tar.gz (5.2 kB view hashes)

Uploaded Source

Built Distribution

feathercarver-0.1.16-py3-none-any.whl (5.7 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page