I created a node module to automate the task of retrieving all files and folders: mddir
Using
node mddir "../relative/path/"
To install: npm install mddir -g
To create markdowns for the current directory: mddir
Generate for any absolute path: mddir / absolute / path
Generate for relative path: mddir ~ / Documents / whatever.
The md file is created in your working directory.
Currently ignoring the node_modules and .git folders.
Troubleshooting
If you get the error message "node \ r: There is no such file or directory", the problem is that your operating system uses different line endings and mddir cannot parse them without explicitly setting the line ending style on Unix. This usually affects Windows, but also some versions of Linux. Setting the end of the line in Unix style should be done in the bin mddir npm global folder.
Line fixes
Get the path to the npm bin folder with:
npm config get prefix
Cd to this folder
brew install dos2unix
dos2unix lib / node_modules / mddir / src / mddir.js
This converts line endings to Unix instead of Dos
Then do as usual: node mddir "../relative/path/".
I made another call to the node agd module to generate a tree view based on another module: https://github.com/JohnByrneRepo/agd .
Automatic Generated Documentation (Alpha)
Functionality so far:
Creates a tree folder structure in node that appears as a tree in the browser. Click on the file (non-root level) to fill in the main view.
Soon:
Creates a documentation guide, including function names and parameters, function dependencies, etc. Originally compatible with jQuery and a simple JavaScript function name extension, which will soon be compatible with React, Redux, Angular 1, Angular 2, and other frames on request.
Using
node agd relativePath
eg. node agd '../../'
Generated .json code.
Launch 'node http-server', then open a browser to view the file structure displayed in the sidebar. Large projects can take up to a minute or two to do.
See .json code, for example, generated data.
To-do: add code content for top-level files. Move the html tree to node.
Contact html5css3@outlook.com
MIT License
An example of a generated tree structure
