Я создал модуль узла для автоматизации этой задачи: mddir
Использование
узел mddir "../relative/path/"
Для установки: npm установить mddir -g
Чтобы создать уценку для текущего каталога: mddir
Чтобы сгенерировать для любого абсолютного пути: mddir / absolute / path
Для создания относительного пути: mddir ~ / Documents / what.
Файл md генерируется в вашем рабочем каталоге.
В настоящее время игнорирует модули node_modules и .git.
Устранение неполадок
Если вы получаете сообщение об ошибке «узел \ r: такой файл или каталог отсутствует», проблема заключается в том, что ваша операционная система использует разные окончания строк, и mddir не сможет их проанализировать без явного задания стиля окончания строк в Unix. Обычно это влияет на Windows, но также и на некоторые версии Linux. Установка конца строки в стиле Unix должна выполняться в глобальной папке bin mddir npm.
Исправление окончаний строки
Получить путь к папке npm bin с помощью:
npm config get prefix
Cd в эту папку
brew install 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