このタスクを自動化するノードモジュールを作成しました:mddir
使用法
ノードmddir "../relative/path/"
インストールする場合:npm install mddir -g
現在のディレクトリのマークダウンを生成するには:mddir
絶対パスを生成するには:mddir / absolute / path
相対パスを生成するには:mddir〜/ Documents / whatever。
mdファイルが作業ディレクトリに生成されます。
現在、node_modules、および.gitフォルダーは無視されます。
トラブルシューティング
エラー「node \ r:No such file or directory」が表示される場合、問題は、オペレーティングシステムが別の行末を使用しており、行末スタイルをUnixに明示的に設定しないと、mddirがそれらを解析できないことです。これは通常Windowsに影響しますが、一部のバージョンのLinuxにも影響します。行末をUnixスタイルに設定するには、mddir npmグローバルbinフォルダー内で実行する必要があります。
行末修正
npm binフォルダーのパスを取得します。
npm config get prefix
そのフォルダーにCd
醸造インストールdos2unix
dos2unix lib / node_modules / mddir / src / mddir.js
これは行末をDosではなくUnixに変換します
次に、通常どおり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