Skip to main content

CLI tool to convert Context7 llms.txt format to locally organized markdown documentation

Project description

Context7 to Markdown (c2md)

A blazing fast CLI tool that converts Context7 URLs & llms.txt files to organized markdown documentation with automatic directory structure, multi-language parsing support, and table of contents generation. Supports both local files and direct URLs from Context7.com.

Install with pip

pip install c2md

Install with uv

uv pip install c2md
uvx c2md

Features

⚓ Convert Context7 to Markdown

Transform Context7 links or llms.txt files into clean, organized markdown documentation.

🧠 Smart Organization

Automatically organizes markdown files into logical directory structures based on source URLs.

🗨️ Multi-Language Support

Consolidates multi-language sections into a single document.

📜 Table of Contents

Generates comprehensive index files to provide context to your agent.

🗺️ URL Mapping

Intelligently maps source URLs to appropriate file paths and names

❌ Error Handling

Robust error handling with detailed feedback for troubleshooting

Why c2md? 🤔

MCP is clunky, slow, adds additional prompt context, and time consuming.

With c2md, you can pass a specific section of a technology's documentation to an agent. Instead of fairly unreliable natural language search with the Context7 MCP server, you can just attach the @/path/to/000-index.md to your agent.

Depending on the number of locally available documentation sections/files, this can save tokens/context. For example, the Neon docs have around 240 sections (520,000 tokens), with the total 000-index.md costing around 4,000 tokens; alternatively, calls to the Context7 MCP can cost anywhere from 8,000 to 20,000 tokens.

Installation

Using pip

pip install c2md

Using uv

uv pip install c2md

or

uvx c2md

📋 Requirements

  • Python 3.8 or higher
  • No external dependencies required unless developing

🛠️ Usage

After installation, use the c2md command:

Basic Usage

# From local file - output defaults to ./output/
c2md /path/to/llms.txt

# From Context7 URL (must include tokens parameter)
c2md https://context7.com/context7/neon/llms.txt?tokens=519821

Advanced Usage

# Specify output directory, 001-index.md (ToC) generated in output root
c2md /path/to/llms.txt -d /path/to/output

# From Context7 URL with output directory
c2md https://context7.com/context7/neon/llms.txt?tokens=519821 -d .docs/neon

# Disable ToC generation
c2md /path/to/llms.txt --no-tree

# Full example with all options, no ToC/tree
c2md https://context7.com/context7/supabase/llms.txt?tokens=1000000 -d /path/to/output --no-tree

Command Line Options

  • input_file: Path to the Context7 format input file or Context7 URL (required)
  • -d, --directory: Output directory (default: current directory)
  • -T, --tree: Generate table of contents index (default: enabled)
  • --no-tree: Disable table of contents generation
  • -h, --help: Show help message and exit
Developing locally & contributing

Contributing 🤝

Contributions are welcome! Please feel free to submit a PR if you would like to contribute or have an issue.

Development Installation

# Clone the repository
git clone https://github.com/crisp-sh/context7-to-markdown.git
cd context7-to-markdown

# Install in development mode
pip install -e .

Output Structure

The tool creates an organized directory structure:

output/
├── 001-index.md                    # Table of contents (if enabled)
├── domain1.com/
│   ├── section1/
│   │   ├── 001-page1.md
│   │   └── 002-page2.md
│   └── section2/
│       └── 001-page3.md
└── domain2.com/
    └── docs/
        └── 001-guide.md

Context7 Format

The tool processes Context7 format files, which should contain entries with:

  • SOURCE: URL or source identifier
  • CONTENT: The actual content to be converted
  • TITLE: Optional title for the content
  • LANGUAGE: Denotes a multi-language document

Architecture

The tool consists of several modular components:

  • Parser: Processes Context7 format files
  • URL Mapper: Maps source URLs to file paths
  • File Organizer: Organizes content into directory structures
  • Markdown Writer: Generates clean markdown files
  • Index Generator: Creates table of contents

Testing

Run the test suite using Hatch:

# Run tests
hatch run test

# Run tests with coverage
hatch run test-cov

# Run specific test file
hatch run test tests/test_specific.py

Legacy Testing

# Install development dependencies
pip install -e ".[dev]"

# Run tests
python -m unittest discover tests

# Run tests with coverage
python -m unittest discover tests

Releasing

This project uses automated versioned releases with Hatch for version management.

Quick Release

# Create a patch release (0.1.0 → 0.1.1)
hatch run release patch

# Create a minor release (0.1.0 → 0.2.0)
hatch run release minor

# Create a major release (0.1.0 → 1.0.0)
hatch run release major

Development Setup

# Clone the repository
git clone https://github.com/crisp-sh/context7-to-markdown.git
cd context7-to-markdown

# Create a virtual environment
python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate

# Install
pip install -e .

Running Tests

# Run all tests with Hatch
hatch run test

# Run specific test file
hatch run test tests/test_specific.py

# Run tests with coverage
hatch run test-cov

Bug Reports

If you encounter any issues, please report them on the GitHub Issues page.

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

c2md-1.0.1.tar.gz (20.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

c2md-1.0.1-py3-none-any.whl (24.2 kB view details)

Uploaded Python 3

File details

Details for the file c2md-1.0.1.tar.gz.

File metadata

  • Download URL: c2md-1.0.1.tar.gz
  • Upload date:
  • Size: 20.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for c2md-1.0.1.tar.gz
Algorithm Hash digest
SHA256 e71ac41156220579c732f487925cdd7c5a818e9808d9d4f52563532f9f8435a8
MD5 bd68175cedffc97b87f017c6dd6d1c6f
BLAKE2b-256 1cd9e655853f70eb2dcbc59f3d8a3b8e298a94fda59bcdb588f338917aaac7f0

See more details on using hashes here.

Provenance

The following attestation bundles were made for c2md-1.0.1.tar.gz:

Publisher: release.yml on crisp-sh/context7-to-markdown

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file c2md-1.0.1-py3-none-any.whl.

File metadata

  • Download URL: c2md-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 24.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for c2md-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 d9c93fb1f19bbe758a74ccfdf7eca37a24c6421940e5876745bd35a7b9027802
MD5 90a2763cd50e846bf4ee6c3705b8d16a
BLAKE2b-256 899c642d57f7088be0a05c4d73998f5c3cf4132648ca6190337207e7f1de98fe

See more details on using hashes here.

Provenance

The following attestation bundles were made for c2md-1.0.1-py3-none-any.whl:

Publisher: release.yml on crisp-sh/context7-to-markdown

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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