Sha256: b49775749ad3a3d6cb135a41f5bee44b436d1a8914ae3b9fd848355fc27a6853
Contents?: true
Size: 1.59 KB
Versions: 9
Compression:
Stored size: 1.59 KB
Contents
# frozen_string_literal: true
require "nokogiri"
require "uri"
require "yard"
require_relative 'relative_markdown_links/version'
module YARD # rubocop:disable Style/Documentation
# GitHub and YARD render Markdown files differently. In particular, relative
# links between Markdown files that work in GitHub don't work in YARD.
# For example, if you have `[hello](FOO.md)` in your README, YARD renders it
# as `<a href="FOO.md">hello</a>`, creating a broken link in your docs.
#
# With this plugin enabled, you'll get `<a href="file.FOO.html">hello</a>`
# instead, which correctly links through to the rendered HTML file.
module RelativeMarkdownLinks
# Resolves relative links from Markdown files.
# @param [String] text the HTML fragment in which to resolve links.
# @return [String] HTML with relative links to extra files converted to `{file:}` links.
def resolve_links(text)
html = Nokogiri::HTML.fragment(text)
html.css("a[href]").each do |link|
begin
href = URI(link["href"])
rescue
return super(text)
end
if href.relative? && options.files
fnames = options.files.map(&:filename)
if fnames.include?(href.path)
link.replace "{file:#{href} #{link.inner_html}}"
elsif href.path.end_with?('_md.html') && (fname = fnames.find {|fnm| fnm.end_with?(href.path.sub(/_md.html\Z/, '.md')) })
link.replace "{file:#{fname} #{link.inner_html}}"
end
end
end
super(html.to_s)
end
end
Templates::Template.extra_includes << RelativeMarkdownLinks
end
Version data entries
9 entries across 9 versions & 1 rubygems