Skip to content

ericlincn/Code2MD

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

3 Commits
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

Code2MD

A Python script to generate a structured Markdown document from your project's source code. It automatically:

  • ๐Ÿ“‚ Builds a directory tree โ€“ Visualize your project structure.
  • ๐Ÿ“ Embeds code files โ€“ Supports syntax highlighting for multiple extensions.
  • โš™๏ธ Customizable filters โ€“ Exclude directories, limit file extensions, and control recursion.

Perfect for sharing code snippets, documenting projects, or creating portable code reports!

Features

  • Recursive/non-recursive directory traversal
  • Exclude specific folders (e.g., node_modules, venv)
  • Filter by file extensions (e.g., .py, .js, .html)
  • Clean Markdown output with code blocks

Usage

python code_to_markdown.py /your/project/path [--non-recursive] [--exclude-dirs dir1 dir2] [--extensions .py .js]

About

A Python script to generate a structured Markdown document from your project's source code.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages