GitHub - tesserato/CodeWeaver: 将你的代码库编织成一个单一的、可导航的 Markdown 文档

主要观点:介绍了 CodeWeaver 这一命令行工具,可将代码库转换为单个可导航的 Markdown 文档,包括其特点、安装方法、用法、示例、贡献方式、许可证等信息,还列举了类似工具及相关的 VSCode 扩展。
关键信息

  • 能递归扫描目录,创建项目文件结构的树状表示并嵌入文件内容到 Markdown 代码块中。
  • 具有多种功能,如生成全面文档、包含代码内容、灵活路径过滤等。
  • 可通过go install或下载预构建执行文件安装。
  • 用法多样,可设置输入输出路径、过滤规则等,还能复制到剪贴板。
  • 欢迎贡献,代码基于 MIT 许可证。
    重要细节
  • 输出示例可在这里查看。
  • 安装时 Go 版本需 1.18 或以上。
  • -include-ignore可精确控制文件包含和排除。
  • 示例中展示了各种使用场景及正则表达式的用法。
  • 列举了众多类似工具及相关的 VSCode 扩展。
阅读 8
0 条评论