Skip to content

User Guide

The User Guide provides comprehensive documentation for using Folder2MD4LLMs effectively. Whether you're converting small scripts or large codebases, these guides will help you get the most out of the tool.

Core Concepts

Understanding Smart Condensing

Folder2MD4LLMs doesn't just truncate files when they exceed token limits. Instead, it uses Abstract Syntax Tree (AST) analysis to understand code structure and condense content intelligently while preserving meaning.

Token Management

Different LLMs have different context windows. Folder2MD4LLMs helps you target specific token limits to ensure your converted content fits perfectly.

Multi-Format Support

The tool handles not just code files, but also documents (PDF, DOCX, XLSX), images, archives, and more.

Guide Topics

Configuration

Learn how to use YAML configuration files to set up complex conversion rules, including patterns, token limits, and processing options.

File Types

Understand which file types are supported, how they're processed, and how to handle special cases.

Filtering

Master the include/exclude pattern system to precisely control which files are processed.

Common Workflows

Development Workflow

  1. Initial Setup: Create a folder2md.yaml configuration for your project
  2. Regular Conversion: Use the configuration for consistent results
  3. Refinement: Adjust patterns based on output quality

Team Collaboration

  • Shared Configuration: Version control your folder2md.yaml files
  • Consistent Output: Ensure all team members get the same results
  • Documentation: Use for code reviews and documentation generation

CI/CD Integration

  • Automated Documentation: Generate project summaries in CI
  • Quality Gates: Ensure code documentation standards
  • Artifact Generation: Create LLM-ready project descriptions

Best Practices

File Organization

  • Keep configuration files in project roots
  • Use descriptive output filenames
  • Organize by project or component

Pattern Management

  • Start with broad patterns, then refine
  • Use dry runs to test pattern changes
  • Document complex patterns in your config

Performance Optimization

  • Use parallel processing for large projects
  • Set appropriate file size limits
  • Filter out unnecessary file types early

Getting Started

If you're new to Folder2MD4LLMs:

  1. Installation - Set up the tool
  2. First Conversion - Try a simple example
  3. Configuration - Learn about config files
  4. Advanced Features - Explore powerful capabilities

Quick Reference

For experienced users, check out the Quick Reference for command patterns and common configurations.

Need Help?