therealwebguy's sandbox: Bundle Markdown

The Bundle Markdown module provides a drush utility command which allows you to export various entity types and their bundles into markdown format for use in Gitbooks or other markdown supported reporting tools. It was designed to provide a means of generating architectural documentation of ones Drupal site.

Module Status: The module is still in active development and at the time of this writing, only supports exporting 'node' entity types.

How To Use This Module
Once the module has been installed and drush cache has been cleared, you will have access to a new drush command:

drush bundle-markdown-export (bme)

The drush command is designed to accept two parameters: (entity_type, bundle_name). As if this writing, the entity_type defaults to 'node', however, if you would like to export only a single bundle, you will need to include 'node' as the first argument. Lets take a look at two examples:

Export all node bundles:

drush bme

Export only the Article bundle

drush bme node article

Ongoing Development Todos
This module should allow users to export any bundle from any entity_type. This is still under active development and community contribution is greatly appreciated. Additionally, the format of the markdown output should be more configurable (e.g, users should be able to specify which field components they want exported in the markdown) whereas now, this is hard coded.