Я зробив модуль вузла для автоматизації цього завдання: mddir
Використання
вузол mddir "../relative/path/"
Щоб встановити: npm встановіть mddir -g
Для створення розмітки для поточного каталогу: mddir
Для генерації будь-якого абсолютного шляху: mddir / absolut / path
Для генерації відносного шляху: mddir ~ / Документи / що завгодно.
Файл md генерується у вашому робочому каталозі.
В даний час ігнорує node_modules та .git папки.
Вирішення проблем
Якщо ви отримуєте помилку "вузол \ r: такого файлу чи каталогу немає", проблема полягає в тому, що ваша операційна система використовує різні закінчення рядків, і mddir не може їх розібрати, не чітко встановивши стиль закінчення рядка в Unix. Зазвичай це стосується Windows, але також і деяких версій Linux. Встановлення закінчень рядків у стилі Unix має виконуватися в глобальній папці бін mddir npm.
Виправити закінчення рядків
Отримайте шлях до папки npm bin за допомогою:
npm config get prefix
CD у цю папку
варити встановити dos2unix
dos2unix lib / node_modules / mddir / src / mddir.js
Це перетворює закінчення рядків в Unix замість Dos
Потім запустіть як звичайно з: node mddir "../relative/path/".
Приклад створеної структури файлу розмітки "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