Sha256: 46a4d479a2a53aeb2b40ed94bfc6b99c4c3e4518f6f76232f6e00bf0b5a653ed

Contents?: true

Size: 739 Bytes

Versions: 4

Compression:

Stored size: 739 Bytes

Contents

### Gemify Images

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

#### The Problem

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.

#### The Solution

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,

Version data entries

4 entries across 4 versions & 1 rubygems

Version Path
markdown_helper-2.0.0 markdown/use_cases/resolve/gemify_images/template.md
markdown_helper-1.9.9 markdown/use_cases/resolve/gemify_images/template.md
markdown_helper-1.9.5 markdown/use_cases/resolve/gemify_images/template.md
markdown_helper-1.9.0 markdown/use_cases/resolve/gemify_images/template.md