Contents

#!/usr/bin/env ruby

relative_image_file_name = 'relative_image.md'
absolute_image_file_name = 'resolved_image.md'
template_file_name = 'template.md'
use_case_file_name = 'gemify_images.md'

resolve_command = "markdown_helper resolve --pristine #{relative_image_file_name} #{absolute_image_file_name}"

File.write(
    relative_image_file_name,
    <<EOT
![html_image](../../../images/html.png)
EOT
)

# Example resolution.
system(resolve_command)

File.write(
    template_file_name,
    <<EOT
### Gemify Images

Use the markdown helper to resolve image paths for a Ruby gem.

When you release your GitHub project to  gem at RubyGems.org, the documentation is rebuilt into files on RubyDoc.info.  When YARD performs this rebuilding, it does some directory restructuring.

If a markdown file contains an image description that has a relative file path, that path will not be valid in the documentation on RubyDoc.info, and the image will not display in the documentation.

To avoid that error, use the markdown helper to resolve the relative path to an absolute path.

This new absolute path points to a file that's automatically maintained in the GitHub project.  For that reason,
EOT
)

# Build use case.
build_command = "markdown_helper include --pristine #{template_file_name} #{use_case_file_name}"
system(build_command)

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
markdown_helper-1.8.0	markdown/use_cases/resolve/gemify_images/gemify_images.rb