code2md

Простая утилита для сканирования структуры проекта и сбора содержимого всех файлов в один Markdown файл.

🚀 Основные возможности

• Генерация дерева проекта: Создает наглядное дерево каталогов.
• Включение содержимого файлов: Вставляет исходный код с автоматической подсветкой синтаксиса.
• Гибкая настройка: Позволяет исключать ненужные папки, файлы и расширения.
• Простота использования: Запускается одной командой.

📦 Установка

Для работы требуется Python 3.7 или новее.

1. Клонируйте репозиторий и перейдите в его директорию:

   git clone https://github.com/Otherwolf/code2md.git
   cd code2md

2. Установите пакет через pip:

   pip install .

🛠️ Использование

1. Перейдите в корневую директорию проекта, который вы хотите обработать.
2. Выполните команду:

   code2md

В результате в текущей директории будет создан файл project_<имя_папки>_structure.md.

Параметры командной строки

Вы можете кастомизировать сборку с помощью следующих флагов:

Флаг	Описание	Пример
-d, --exclude-dirs	Исключить директории (через запятую).	code2md -d ".git,build"
-f, --exclude-files	Исключить файлы (через запятую).	code2md -f ".env,config.local.json"
-e, --exclude-extensions	Исключить расширения (через запятую).	code2md -e ".log,.tmp"
-o, --output-dir	Папка для сохранения итогового файла.	code2md -o "output/docs"
-v, --verbose	Включить подробный вывод процесса.	code2md -v

Исключения по умолчанию

Утилита по умолчанию игнорирует стандартные для разработки файлы и папки для поддержания чистоты вывода.

• Папки: .git, .idea, .vscode, __pycache__, node_modules, dist, .env, .venv, certs, build, egg-info, .ruff_cache, .pytest_cache
• Файлы: uv.lock, package-lock.json, .DS_Store
• Расширения: .tgz, .mp3, .lock, .log

Любые пользовательские исключения, указанные через флаги, будут добавлены к этому списку.