Create Project Markdown
A powerful Python utility that transforms your project's codebase into a set of well-organized markdown documentation files, chunked to easy context processing in target systems. Perfect for creating llm-context compatible comprehensive project documentation with minimal effort.
Key Features
Automated Documentation
Automatically scans and processes your entire project directory, creating a unified documentation structure that's easy to navigate and maintain.
Multiple File Support
Handles various file types and seamlessly integrates their contents into a cohesive markdown document, preserving code formatting and structure.
Customizable Output
Configure the documentation generation process to match your project's specific needs and documentation standards.
Developer Friendly
Simple to integrate into existing workflows with straightforward configuration and clear logging for troubleshooting.
Getting Started
Visit our GitHub repository to get started with Create Project Markdown. The tool is designed to be simple to use while providing powerful documentation capabilities.
Quick Installation
pip install create-project-markdownBasic Usage
python -m create_project_markdown --input-dir /path/to/your/project --output-file documentation.mdContributing
We welcome contributions from the community! Whether it's adding new features, improving documentation, or reporting bugs, your input helps make Create Project Markdown better for everyone.
Check out our GitHub Issues page to see where you can help or to report any problems you encounter.