Escribí un pequeño guión que hace el truco:

#!/bin/bash

#File: tree-md

tree=$(tree -tf --noreport -I '*~' --charset ascii $1 |
       sed -e 's/| \+/  /g' -e 's/[|`]-\+/ */g' -e 's:\(* \)\(\(.*/\)\([^/]\+\)\):\1[\4](\2):g')

printf "# Project tree\n\n${tree}"

Ejemplo:

Orden original del árbol:

$ tree
.
├── dir1
│   ├── file11.ext
│   └── file12.ext
├── dir2
│   ├── file21.ext
│   ├── file22.ext
│   └── file23.ext
├── dir3
├── file_in_root.ext
└── README.md

3 directories, 7 files

Comando del árbol de Markdown:

$ ./tree-md .
# Project tree

.
 * [tree-md](./tree-md)
 * [dir2](./dir2)
   * [file21.ext](./dir2/file21.ext)
   * [file22.ext](./dir2/file22.ext)
   * [file23.ext](./dir2/file23.ext)
 * [dir1](./dir1)
   * [file11.ext](./dir1/file11.ext)
   * [file12.ext](./dir1/file12.ext)
 * [file_in_root.ext](./file_in_root.ext)
 * [README.md](./README.md)
 * [dir3](./dir3)

Resultado renderizado:

(Los enlaces no son visibles en Stackoverflow...)

• tree-md
• dir2
  • file21.ext
  • file22.ext
  • file23.ext
• dir1
  • file11.ext
  • file12.ext
• file_in_root.ext
• README.md
• dir3

Conseguí resolver el problema de esta manera:

1. Insertar comando tree en bash.

   Ejemplo

   

2. Crear un README.md en el repositorio github y copie la página del bash

3. Insertar código de descuento

   Ejemplo

   

4. Ver la salida y ser feliz =)

   

Hice un módulo de nodo para automatizar esta tarea: mddir

Uso

Nodo mddir "../relative/path / "

Para instalar: npm install mddir-g

Para generar markdown para el directorio actual: mddir

Para generar para cualquier ruta absoluta: mddir/absolute / path

Para generar una ruta relativa: mddir ~/Documents/whatever.

El archivo md se genera en su directorio de trabajo.

Actualmente ignora node_modules, and.git carpeta.

Solución de problemas

Si recibe el error 'node\r: No such file or directory', el problema es que su sistema operativo utiliza diferentes terminaciones de línea y mddir no puede analizarlas sin establecer explícitamente el estilo de terminación de línea a Unix. Esto suele afectar a Windows, pero también a algunas versiones de Linux. La configuración de los finales de línea al estilo Unix debe realizarse dentro de la carpeta global bin mddir npm.

Finales de línea fix

Obtener la ruta de la carpeta npm bin con:

npm config get prefix

Cd en esa carpeta

Instalación de brew dos2unix

Dos2unix lib/node_modules/mddir/src/mddir.js

Esto convierte los finales de línea a Unix en lugar de Dos

Luego ejecute de forma normal con: nodo mddir"../ relative / path/".

Ejemplo de estructura de archivo de markdown generado 'directoryList.md"

    |-- .bowerrc
    |-- .jshintrc
    |-- .jshintrc2
    |-- Gruntfile.js
    |-- README.md
    |-- bower.json
    |-- karma.conf.js
    |-- package.json
    |-- app
        |-- app.js
        |-- db.js
        |-- directoryList.md
        |-- index.html
        |-- mddir.js
        |-- routing.js
        |-- server.js
        |-- _api
            |-- api.groups.js
            |-- api.posts.js
            |-- api.users.js
            |-- api.widgets.js
        |-- _components
            |-- directives
                |-- directives.module.js
                |-- vendor
                    |-- directive.draganddrop.js
            |-- helpers
                |-- helpers.module.js
                |-- proprietary
                    |-- factory.actionDispatcher.js
            |-- services
                |-- services.cardTemplates.js
                |-- services.cards.js
                |-- services.groups.js
                |-- services.posts.js
                |-- services.users.js
                |-- services.widgets.js
        |-- _mocks
            |-- mocks.groups.js
            |-- mocks.posts.js
            |-- mocks.users.js
            |-- mocks.widgets.js

La mejor manera de hacer esto es rodear el árbol en los tres backsticks para denotar un bloque de código. Para obtener más información, consulte los documentos de markdown: http://daringfireball.net/projects/markdown/syntax#code

Puedes usar etiquetas

 como lo hice en uno de mis proyectos  .

También puede comprobar este paquete tree-extended. Se puede usar como una aplicación de línea de comandos usando node > = 6.x.

Es muy similar a tree pero también tiene la opción de configurar el max deep en el árbol, que es una de las cosas horribles del mismo. También puede filtrar usando el archivo .gitignore.

Si está usando Atom editor, puede usar este paquete para escribir fácilmente árboles ASCII: ascii-tree