RubyGems - rdoc - Versions diffs - 6.13.0 → 6.17.0 - Mend

rdoc 6.13.0 → 6.17.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (142) hide show

checksums.yaml +4 -4
data/History.rdoc +1 -1
data/README.md +112 -0
data/RI.md +1 -1
data/lib/rdoc/code_object/any_method.rb +4 -4
data/lib/rdoc/code_object/attr.rb +3 -3
data/lib/rdoc/code_object/class_module.rb +18 -16
data/lib/rdoc/code_object/constant.rb +5 -5
data/lib/rdoc/code_object/context/section.rb +8 -7
data/lib/rdoc/code_object/context.rb +19 -19
data/lib/rdoc/code_object/method_attr.rb +7 -6
data/lib/rdoc/code_object/mixin.rb +3 -3
data/lib/rdoc/code_object/normal_class.rb +1 -1
data/lib/rdoc/code_object/normal_module.rb +1 -1
data/lib/rdoc/code_object/single_class.rb +1 -1
data/lib/rdoc/code_object/top_level.rb +28 -33
data/lib/rdoc/code_object.rb +3 -3
data/lib/rdoc/comment.rb +196 -14
data/lib/rdoc/cross_reference.rb +4 -4
data/lib/rdoc/encoding.rb +4 -4
data/lib/rdoc/erb_partial.rb +1 -1
data/lib/rdoc/erbio.rb +2 -2
data/lib/rdoc/generator/aliki.rb +42 -0
data/lib/rdoc/generator/darkfish.rb +20 -16
data/lib/rdoc/generator/json_index.rb +3 -3
data/lib/rdoc/generator/markup.rb +12 -0
data/lib/rdoc/generator/pot/message_extractor.rb +4 -4
data/lib/rdoc/generator/pot/po.rb +1 -1
data/lib/rdoc/generator/pot/po_entry.rb +7 -7
data/lib/rdoc/generator/pot.rb +1 -1
data/lib/rdoc/generator/ri.rb +1 -1
data/lib/rdoc/generator/template/aliki/_aside_toc.rhtml +8 -0
data/lib/rdoc/generator/template/aliki/_footer.rhtml +23 -0
data/lib/rdoc/generator/template/aliki/_head.rhtml +158 -0
data/lib/rdoc/generator/template/aliki/_header.rhtml +56 -0
data/lib/rdoc/generator/template/aliki/_icons.rhtml +208 -0
data/lib/rdoc/generator/template/aliki/_sidebar_ancestors.rhtml +16 -0
data/lib/rdoc/generator/template/aliki/_sidebar_classes.rhtml +15 -0
data/lib/rdoc/generator/template/aliki/_sidebar_extends.rhtml +25 -0
data/lib/rdoc/generator/template/aliki/_sidebar_includes.rhtml +25 -0
data/lib/rdoc/generator/template/aliki/_sidebar_installed.rhtml +16 -0
data/lib/rdoc/generator/template/aliki/_sidebar_methods.rhtml +41 -0
data/lib/rdoc/generator/template/aliki/_sidebar_pages.rhtml +67 -0
data/lib/rdoc/generator/template/aliki/_sidebar_search.rhtml +15 -0
data/lib/rdoc/generator/template/aliki/_sidebar_sections.rhtml +21 -0
data/lib/rdoc/generator/template/aliki/_sidebar_toggle.rhtml +3 -0
data/lib/rdoc/generator/template/aliki/class.rhtml +220 -0
data/lib/rdoc/generator/template/aliki/css/rdoc.css +1737 -0
data/lib/rdoc/generator/template/aliki/index.rhtml +22 -0
data/lib/rdoc/generator/template/aliki/js/aliki.js +483 -0
data/lib/rdoc/generator/template/aliki/js/c_highlighter.js +299 -0
data/lib/rdoc/generator/template/aliki/js/search.js +120 -0
data/lib/rdoc/generator/template/aliki/js/theme-toggle.js +112 -0
data/lib/rdoc/generator/template/aliki/page.rhtml +18 -0
data/lib/rdoc/generator/template/aliki/servlet_not_found.rhtml +14 -0
data/lib/rdoc/generator/template/aliki/servlet_root.rhtml +65 -0
data/lib/rdoc/generator/template/darkfish/_footer.rhtml +3 -3
data/lib/rdoc/generator/template/darkfish/_head.rhtml +16 -16
data/lib/rdoc/generator/template/darkfish/_sidebar_extends.rhtml +8 -8
data/lib/rdoc/generator/template/darkfish/_sidebar_includes.rhtml +8 -8
data/lib/rdoc/generator/template/darkfish/_sidebar_installed.rhtml +7 -6
data/lib/rdoc/generator/template/darkfish/_sidebar_methods.rhtml +6 -6
data/lib/rdoc/generator/template/darkfish/_sidebar_pages.rhtml +19 -19
data/lib/rdoc/generator/template/darkfish/_sidebar_parent.rhtml +2 -2
data/lib/rdoc/generator/template/darkfish/_sidebar_search.rhtml +1 -0
data/lib/rdoc/generator/template/darkfish/_sidebar_sections.rhtml +3 -3
data/lib/rdoc/generator/template/darkfish/_sidebar_table_of_contents.rhtml +14 -14
data/lib/rdoc/generator/template/darkfish/class.rhtml +62 -60
data/lib/rdoc/generator/template/darkfish/css/rdoc.css +2 -0
data/lib/rdoc/generator/template/darkfish/index.rhtml +4 -3
data/lib/rdoc/generator/template/darkfish/js/darkfish.js +21 -1
data/lib/rdoc/generator/template/darkfish/js/search.js +11 -1
data/lib/rdoc/generator/template/darkfish/page.rhtml +2 -1
data/lib/rdoc/generator/template/darkfish/servlet_not_found.rhtml +2 -1
data/lib/rdoc/generator/template/darkfish/servlet_root.rhtml +19 -19
data/lib/rdoc/generator/template/darkfish/table_of_contents.rhtml +19 -17
data/lib/rdoc/generator/template/json_index/js/searcher.js +48 -6
data/lib/rdoc/generator.rb +1 -0
data/lib/rdoc/markdown.kpeg +72 -18
data/lib/rdoc/markdown.rb +411 -547
data/lib/rdoc/markup/attribute_manager.rb +5 -5
data/lib/rdoc/markup/attributes.rb +3 -3
data/lib/rdoc/markup/blank_line.rb +2 -2
data/lib/rdoc/markup/block_quote.rb +1 -1
data/lib/rdoc/markup/document.rb +8 -8
data/lib/rdoc/markup/formatter.rb +12 -12
data/lib/rdoc/markup/hard_break.rb +3 -3
data/lib/rdoc/markup/heading.rb +4 -4
data/lib/rdoc/markup/include.rb +3 -3
data/lib/rdoc/markup/indented_paragraph.rb +3 -3
data/lib/rdoc/markup/list.rb +4 -4
data/lib/rdoc/markup/list_item.rb +4 -4
data/lib/rdoc/markup/paragraph.rb +2 -2
data/lib/rdoc/markup/parser.rb +11 -11
data/lib/rdoc/markup/pre_process.rb +39 -15
data/lib/rdoc/markup/raw.rb +5 -5
data/lib/rdoc/markup/rule.rb +2 -2
data/lib/rdoc/markup/table.rb +4 -4
data/lib/rdoc/markup/to_ansi.rb +7 -3
data/lib/rdoc/markup/to_bs.rb +10 -6
data/lib/rdoc/markup/to_html.rb +182 -30
data/lib/rdoc/markup/to_html_crossref.rb +58 -28
data/lib/rdoc/markup/to_html_snippet.rb +17 -17
data/lib/rdoc/markup/to_joined_paragraph.rb +1 -1
data/lib/rdoc/markup/to_label.rb +6 -5
data/lib/rdoc/markup/to_markdown.rb +12 -12
data/lib/rdoc/markup/to_rdoc.rb +40 -31
data/lib/rdoc/markup/to_table_of_contents.rb +3 -3
data/lib/rdoc/markup/to_test.rb +1 -1
data/lib/rdoc/markup/to_tt_only.rb +8 -8
data/lib/rdoc/markup/verbatim.rb +3 -3
data/lib/rdoc/markup.rb +3 -3
data/lib/rdoc/options.rb +53 -23
data/lib/rdoc/parser/c.rb +31 -62
data/lib/rdoc/parser/changelog.rb +9 -9
data/lib/rdoc/parser/prism_ruby.rb +122 -114
data/lib/rdoc/parser/ruby.rb +51 -51
data/lib/rdoc/parser/ruby_tools.rb +5 -7
data/lib/rdoc/parser/simple.rb +5 -22
data/lib/rdoc/parser.rb +8 -8
data/lib/rdoc/rd/inline.rb +4 -4
data/lib/rdoc/rd.rb +1 -1
data/lib/rdoc/rdoc.rb +9 -8
data/lib/rdoc/ri/driver.rb +49 -49
data/lib/rdoc/ri/paths.rb +2 -2
data/lib/rdoc/ri/task.rb +3 -3
data/lib/rdoc/rubygems_hook.rb +14 -11
data/lib/rdoc/servlet.rb +15 -15
data/lib/rdoc/stats/normal.rb +1 -1
data/lib/rdoc/stats/quiet.rb +1 -1
data/lib/rdoc/stats/verbose.rb +3 -3
data/lib/rdoc/stats.rb +12 -12
data/lib/rdoc/store.rb +32 -32
data/lib/rdoc/task.rb +6 -6
data/lib/rdoc/text.rb +11 -11
data/lib/rdoc/token_stream.rb +14 -2
data/lib/rdoc/tom_doc.rb +8 -8
data/lib/rdoc/version.rb +1 -1
data/man/ri.1 +2 -0
data/rdoc.gemspec +72 -0
metadata +61 -6
data/README.rdoc +0 -142

data/lib/rdoc/generator/darkfish.rb CHANGED Viewed

@@ -150,7 +150,7 @@ class RDoc::Generator::Darkfish
   ##
   # Initialize a few instance variables before we start
-  def initialize store, options
+  def initialize(store, options)
     @store   = store
     @options = options
@@ -269,7 +269,7 @@ class RDoc::Generator::Darkfish
   # Return a list of the documented modules sorted by salience first, then
   # by name.
-  def get_sorted_module_list classes
+  def get_sorted_module_list(classes)
     classes.select do |klass|
       klass.display?
     end.sort
@@ -313,7 +313,9 @@ class RDoc::Generator::Darkfish
   ##
   # Generates a class file for +klass+
-  def generate_class klass, template_file = nil
+  def generate_class(klass, template_file = nil)
+    # This is used to auto-collapse Pages section on class/module pages
+    @inside_class_file = true
     current = klass
     template_file ||= @template_dir + 'class.rhtml'
@@ -338,6 +340,8 @@ class RDoc::Generator::Darkfish
       here.local_variable_set(:asset_rel_prefix, asset_rel_prefix)
       here
     end
+  ensure
+    @inside_class_file = false
   end
   ##
@@ -435,7 +439,7 @@ class RDoc::Generator::Darkfish
   ##
   # Generate a page file for +file+
-  def generate_page file
+  def generate_page(file)
     template_file = @template_dir + 'page.rhtml'
     out_file = @outputdir + file.path
@@ -462,7 +466,7 @@ class RDoc::Generator::Darkfish
   ##
   # Generates the 404 page for the RDoc servlet
-  def generate_servlet_not_found message
+  def generate_servlet_not_found(message)
     template_file = @template_dir + 'servlet_not_found.rhtml'
     return unless template_file.exist?
@@ -493,7 +497,7 @@ class RDoc::Generator::Darkfish
   ##
   # Generates the servlet root page for the RDoc servlet
-  def generate_servlet_root installed
+  def generate_servlet_root(installed)
     template_file = @template_dir + 'servlet_root.rhtml'
     return unless template_file.exist?
@@ -547,7 +551,7 @@ class RDoc::Generator::Darkfish
     raise error
   end
-  def install_rdoc_static_file source, destination, options # :nodoc:
+  def install_rdoc_static_file(source, destination, options) # :nodoc:
     return unless source.exist?
     begin
@@ -586,7 +590,7 @@ class RDoc::Generator::Darkfish
   # For backwards compatibility, if +body_file+ contains "<html" the body is
   # used directly.
-  def assemble_template body_file
+  def assemble_template(body_file)
     body = body_file.read
     return body if body =~ /<html/
@@ -595,7 +599,7 @@ class RDoc::Generator::Darkfish
     <<-TEMPLATE
 <!DOCTYPE html>
-<html>
+<html lang="#{@options.locale&.name || 'en'}">
 <head>
 #{head_file.read}
@@ -607,7 +611,7 @@ class RDoc::Generator::Darkfish
   # Renders the ERb contained in +file_name+ relative to the template
   # directory and returns the result based on the current context.
-  def render file_name
+  def render(file_name)
     template_file = @template_dir + file_name
     template = template_for template_file, false, RDoc::ERBPartial
@@ -625,7 +629,7 @@ class RDoc::Generator::Darkfish
   #
   # An io will be yielded which must be captured by binding in the caller.
-  def render_template template_file, out_file = nil # :yield: io
+  def render_template(template_file, out_file = nil) # :yield: io
     io_output = out_file && !@dry_run && @file_output
     erb_klass = io_output ? RDoc::ERBIO : ERB
@@ -659,7 +663,7 @@ class RDoc::Generator::Darkfish
   # Creates the result for +template+ with +context+.  If an error is raised a
   # Pathname +template_file+ will indicate the file where the error occurred.
-  def template_result template, context, template_file
+  def template_result(template, context, template_file)
     template.filename = template_file.to_s
     template.result context
   rescue NoMethodError => e
@@ -672,7 +676,7 @@ class RDoc::Generator::Darkfish
   ##
   # Retrieves a cache template for +file+, if present, or fills the cache.
-  def template_for file, page = true, klass = ERB
+  def template_for(file, page = true, klass = ERB)
     template = @template_cache[file]
     return template if template
@@ -764,7 +768,7 @@ class RDoc::Generator::Darkfish
   end
   def traverse_classes(klasses, grouped_classes, rel_prefix, solo = false)
-    content = +'<ul class="link-list">'
+    content = +'<ul class="link-list nav-list">'
     klasses.each do |index_klass|
       if children = grouped_classes[index_klass.full_name]
@@ -793,7 +797,7 @@ class RDoc::Generator::Darkfish
   private
-  def nesting_namespaces_to_class_modules klass
+  def nesting_namespaces_to_class_modules(klass)
     tree = {}
     klass.nesting_namespaces.zip(klass.fully_qualified_nesting_namespaces) do |ns, fqns|
@@ -803,7 +807,7 @@ class RDoc::Generator::Darkfish
     tree
   end
-  def generate_nesting_namespaces_breadcrumb klass, rel_prefix
+  def generate_nesting_namespaces_breadcrumb(klass, rel_prefix)
     nesting_namespaces_to_class_modules(klass).map do |namespace, class_module|
       path = class_module ? (rel_prefix + class_module.path).to_s : ""
       { name: namespace, path: path, self: klass.full_name == class_module&.full_name }

data/lib/rdoc/generator/json_index.rb CHANGED Viewed

@@ -89,7 +89,7 @@ class RDoc::Generator::JsonIndex
   # Creates a new generator.
   # +options+ are the same options passed to the parent generator.
-  def initialize parent_generator, options
+  def initialize(parent_generator, options)
     @parent_generator = parent_generator
     @store            = parent_generator.store
     @options          = options
@@ -263,7 +263,7 @@ class RDoc::Generator::JsonIndex
     end
   end
-  def reset files, classes # :nodoc:
+  def reset(files, classes) # :nodoc:
     @files   = files
     @classes = classes
@@ -277,7 +277,7 @@ class RDoc::Generator::JsonIndex
   ##
   # Removes whitespace and downcases +string+
-  def search_string string
+  def search_string(string)
     string.downcase.gsub(/\s/, '')
   end

data/lib/rdoc/generator/markup.rb CHANGED Viewed

@@ -55,6 +55,18 @@ module RDoc::Generator::Markup
     end
   end
+  ##
+  # The preferred URL for this object.
+  def canonical_url
+    options = @store.options
+    if path
+      File.join(options.canonical_root, path.to_s)
+    else
+      options.canonical_root
+    end
+  end
 end
 class RDoc::CodeObject

data/lib/rdoc/generator/pot/message_extractor.rb CHANGED Viewed

@@ -7,7 +7,7 @@ class RDoc::Generator::POT::MessageExtractor
   ##
   # Creates a message extractor for +store+.
-  def initialize store
+  def initialize(store)
     @store = store
     @po = RDoc::Generator::POT::PO.new
   end
@@ -25,7 +25,7 @@ class RDoc::Generator::POT::MessageExtractor
   private
-  def extract_from_klass klass
+  def extract_from_klass(klass)
     extract_text(klass.comment_location, klass.full_name)
     klass.each_section do |section, constants, attributes|
@@ -48,7 +48,7 @@ class RDoc::Generator::POT::MessageExtractor
     end
   end
-  def extract_text text, comment, location = nil
+  def extract_text(text, comment, location = nil)
     return if text.nil?
     options = {
@@ -61,7 +61,7 @@ class RDoc::Generator::POT::MessageExtractor
     end
   end
-  def entry msgid, options
+  def entry(msgid, options)
     RDoc::Generator::POT::POEntry.new(msgid, options)
   end

data/lib/rdoc/generator/pot/po.rb CHANGED Viewed

@@ -15,7 +15,7 @@ class RDoc::Generator::POT::PO
   ##
   # Adds a PO entry to the PO.
-  def add entry
+  def add(entry)
     existing_entry = @entries[entry.msgid]
     if existing_entry
       entry = existing_entry.merge(entry)

data/lib/rdoc/generator/pot/po_entry.rb CHANGED Viewed

@@ -26,7 +26,7 @@ class RDoc::Generator::POT::POEntry
   # Creates a PO entry for +msgid+. Other values can be specified by
   # +options+.
-  def initialize msgid, options = {}
+  def initialize(msgid, options = {})
     @msgid = msgid
     @msgstr = options[:msgstr] || ""
     @translator_comment = options[:translator_comment]
@@ -53,7 +53,7 @@ msgstr #{format_message(@msgstr)}
   ##
   # Merges the PO entry with +other_entry+.
-  def merge other_entry
+  def merge(other_entry)
     options = {
       :extracted_comment  => merge_string(@extracted_comment,
                                           other_entry.extracted_comment),
@@ -69,7 +69,7 @@ msgstr #{format_message(@msgstr)}
   private
-  def format_comment mark, comment
+  def format_comment(mark, comment)
     return '' unless comment
     return '' if comment.empty?
@@ -106,7 +106,7 @@ msgstr #{format_message(@msgstr)}
     "\#, #{formatted_flags}\n"
   end
-  def format_message message
+  def format_message(message)
     return "\"#{escape(message)}\"" unless message.include?("\n")
     formatted_message = '""'
@@ -117,7 +117,7 @@ msgstr #{format_message(@msgstr)}
     formatted_message
   end
-  def escape string
+  def escape(string)
     string.gsub(/["\\\t\n]/) do |special_character|
       case special_character
       when "\t"
@@ -130,11 +130,11 @@ msgstr #{format_message(@msgstr)}
     end
   end
-  def merge_string string1, string2
+  def merge_string(string1, string2)
     [string1, string2].compact.join("\n")
   end
-  def merge_array array1, array2
+  def merge_array(array1, array2)
       (array1 + array2).uniq
   end

data/lib/rdoc/generator/pot.rb CHANGED Viewed

@@ -65,7 +65,7 @@ class RDoc::Generator::POT
   ##
   # Set up a new .pot generator
-  def initialize store, options #:not-new:
+  def initialize(store, options) #:not-new:
     @options    = options
     @store      = store
   end

data/lib/rdoc/generator/ri.rb CHANGED Viewed

@@ -14,7 +14,7 @@ class RDoc::Generator::RI
   ##
   # Set up a new ri generator
-  def initialize store, options #:not-new:
+  def initialize(store, options) #:not-new:
     @options    = options
     @store      = store
     @store.path = '.'

data/lib/rdoc/generator/template/aliki/_aside_toc.rhtml ADDED Viewed

@@ -0,0 +1,8 @@
+<aside class="table-of-contents" role="complementary" aria-label="Table of Contents">
+  <div class="toc-sticky">
+    <h3 class="toc-heading">On This Page</h3>
+    <nav class="toc-nav" id="toc-nav" aria-label="Page sections">
+      <!-- Generated by JavaScript based on page headings -->
+    </nav>
+  </div>
+</aside>

data/lib/rdoc/generator/template/aliki/_footer.rhtml ADDED Viewed

@@ -0,0 +1,23 @@
+<footer class="site-footer">
+  <% if @options.footer_content && !@options.footer_content.empty? %>
+  <div class="footer-content">
+    <% @options.footer_content.each do |column_title, links| %>
+    <div>
+      <h3><%= h column_title %></h3>
+      <ul>
+        <% links.each do |text, url| %>
+        <li><a href="<%= h url %>"><%= h text %></a></li>
+        <% end %>
+      </ul>
+    </div>
+    <% end %>
+  </div>
+  <% end %>
+  <div class="footer-bottom">
+    <p>
+      Generated by <a href="https://ruby.github.io/rdoc/">RDoc <%= RDoc::VERSION %></a>
+      using the Aliki theme by <a href="http://st0012.dev">Stan Lo</a>
+    </p>
+  </div>
+</footer>

data/lib/rdoc/generator/template/aliki/_head.rhtml ADDED Viewed

@@ -0,0 +1,158 @@
+<meta charset="<%= @options.charset %>">
+<meta name="viewport" content="width=device-width, initial-scale=1">
+<title><%= h @title %></title>
+<%- if defined?(klass) %>
+  <meta
+    name="keywords"
+    content="ruby,<%= h "#{klass.type},#{klass.full_name}" %>"
+  >
+  <%- if klass.comment.empty? %>
+    <meta
+      name="description"
+      content="Documentation for the <%= h "#{klass.full_name} #{klass.type}" %>"
+    >
+  <%- else %>
+    <meta
+      name="description"
+      content="<%= h "#{klass.type} #{klass.full_name}: #{excerpt(klass.comment)}" %>"
+    >
+  <%- end %>
+<%- elsif defined?(file) %>
+  <meta name="keywords" content="ruby,documentation,<%= h file.page_name %>">
+  <meta
+    name="description"
+    content="<%= h "#{file.page_name}: #{excerpt(file.comment)}" %>"
+  >
+<%- elsif @title %>
+  <meta name="keywords" content="ruby,documentation,<%= h @title %>">
+  <%- if @options.main_page and
+      main_page = @files.find { |f| f.full_name == @options.main_page } then %>
+    <meta
+      name="description"
+      content="<%= h "#{@title}: #{excerpt(main_page.comment)}" %>"
+    >
+  <%- else %>
+    <meta name="description" content="Documentation for <%= h @title %>">
+  <%- end %>
+<%- end %>
+<%- if canonical_url = @options.canonical_root %>
+  <% canonical_url = current.canonical_url if defined?(current) %>
+  <link rel="canonical" href="<%= canonical_url %>">
+<%- end %>
+<!-- Open Graph / Facebook -->
+<meta property="og:type" content="website">
+<meta property="og:title" content="<%= h @title %>">
+<%- if defined?(klass) %>
+  <%- if klass.comment.empty? %>
+    <meta
+      property="og:description"
+      content="Documentation for <%= h klass.full_name %> <%= h klass.type %> - API reference and code examples"
+    >
+  <%- else %>
+    <meta property="og:description" content="<%= h excerpt(klass.comment) %>">
+  <%- end %>
+<%- elsif defined?(file) %>
+  <%- if file.comment.empty? %>
+    <meta
+      property="og:description"
+      content="<%= h file.page_name %> - <%= h @title %> documentation"
+    >
+  <%- else %>
+    <meta property="og:description" content="<%= h excerpt(file.comment) %>">
+  <%- end %>
+<%- else %>
+  <meta
+    property="og:description"
+    content="API documentation for <%= h @title %> - Browse classes, modules, and methods"
+  >
+<%- end %>
+<%- if canonical_url = @options.canonical_root %>
+  <% canonical_url = current.canonical_url if defined?(current) %>
+  <meta property="og:url" content="<%= canonical_url %>">
+<%- end %>
+<!-- Twitter -->
+<meta name="twitter:card" content="summary">
+<meta name="twitter:title" content="<%= h @title %>">
+<%- if defined?(klass) %>
+  <%- if klass.comment.empty? %>
+    <meta
+      name="twitter:description"
+      content="Documentation for <%= h klass.full_name %> <%= h klass.type %> - API reference and code examples"
+    >
+  <%- else %>
+    <meta name="twitter:description" content="<%= h excerpt(klass.comment) %>">
+  <%- end %>
+<%- elsif defined?(file) %>
+  <%- if file.comment.empty? %>
+    <meta
+      name="twitter:description"
+      content="<%= h file.page_name %> - <%= h @title %> documentation"
+    >
+  <%- else %>
+    <meta name="twitter:description" content="<%= h excerpt(file.comment) %>">
+  <%- end %>
+<%- else %>
+  <meta
+    name="twitter:description"
+    content="API documentation for <%= h @title %> - Browse classes, modules, and methods"
+  >
+<%- end %>
+<script type="text/javascript">
+  var rdoc_rel_prefix = "<%= h asset_rel_prefix %>/";
+  var index_rel_prefix = "<%= h rel_prefix %>/";
+</script>
+<script
+  src="<%= h asset_rel_prefix %>/js/theme-toggle.js?v=<%= h RDoc::VERSION %>"
+></script>
+<script
+  src="<%= h asset_rel_prefix %>/js/navigation.js?v=<%= h RDoc::VERSION %>"
+  defer
+></script>
+<script
+  src="<%= h asset_rel_prefix %>/js/search.js?v=<%= h RDoc::VERSION %>"
+  defer
+></script>
+<script
+  src="<%= h asset_rel_prefix %>/js/search_index.js?v=<%= h RDoc::VERSION %>"
+  defer
+></script>
+<script
+  src="<%= h asset_rel_prefix %>/js/searcher.js?v=<%= h RDoc::VERSION %>"
+  defer
+></script>
+<script
+  src="<%= h asset_rel_prefix %>/js/c_highlighter.js?v=<%= h RDoc::VERSION %>"
+  defer
+></script>
+<script
+  src="<%= h asset_rel_prefix %>/js/aliki.js?v=<%= h RDoc::VERSION %>"
+  defer
+></script>
+<link
+  href="<%= h asset_rel_prefix %>/css/rdoc.css?v=<%= h RDoc::VERSION %>"
+  rel="stylesheet"
+>
+<%- @options.template_stylesheets.each do |stylesheet| %>
+  <link
+    href="<%= h asset_rel_prefix %>/<%= h File.basename stylesheet %>?v=<%= h RDoc::VERSION %>"
+    rel="stylesheet"
+  >
+<%- end %>

data/lib/rdoc/generator/template/aliki/_header.rhtml ADDED Viewed

@@ -0,0 +1,56 @@
+<header class="top-navbar">
+  <a href="<%= rel_prefix %>/index.html" class="navbar-brand">
+    <%= h @options.title %>
+  </a>
+  <!-- Desktop search bar -->
+  <div class="navbar-search navbar-search-desktop" role="search">
+    <form action="#" method="get" accept-charset="utf-8">
+      <input id="search-field" role="combobox" aria-label="Search"
+             aria-autocomplete="list" aria-controls="search-results"
+             type="text" name="search" placeholder="Search (/) for a class, method..."
+             spellcheck="false" autocomplete="off"
+             title="Type to search, Up and Down to navigate, Enter to load">
+      <ul id="search-results" aria-label="Search Results"
+          aria-busy="false" aria-expanded="false"
+          aria-atomic="false" class="initially-hidden"></ul>
+    </form>
+  </div>
+  <!-- Mobile search icon button -->
+  <button id="search-toggle" class="navbar-search-mobile" aria-label="Open search" type="button">
+    <span aria-hidden="true">🔍</span>
+  </button>
+  <!-- Theme toggle button -->
+  <button id="theme-toggle" class="theme-toggle" aria-label="Switch to dark mode" type="button">
+    <span class="theme-toggle-icon" aria-hidden="true">🌙</span>
+  </button>
+</header>
+<!-- Search Modal (Mobile) -->
+<div id="search-modal" class="search-modal" hidden aria-modal="true" role="dialog" aria-label="Search">
+  <div class="search-modal-backdrop"></div>
+  <div class="search-modal-content">
+    <div class="search-modal-header">
+      <form class="search-modal-form" action="#" method="get" accept-charset="utf-8">
+        <span class="search-modal-icon" aria-hidden="true">🔍</span>
+        <input id="search-field-mobile" role="combobox" aria-label="Search"
+               aria-autocomplete="list" aria-controls="search-results-mobile"
+               type="text" name="search" placeholder="Search documentation"
+               spellcheck="false" autocomplete="off">
+        <button type="button" class="search-modal-close" aria-label="Close search" id="search-modal-close">
+          <span aria-hidden="true">esc</span>
+        </button>
+      </form>
+    </div>
+    <div class="search-modal-body">
+      <ul id="search-results-mobile" aria-label="Search Results"
+          aria-busy="false" aria-expanded="false"
+          aria-atomic="false" class="search-modal-results initially-hidden"></ul>
+      <div class="search-modal-empty">
+        <p>No recent searches</p>
+      </div>
+    </div>
+  </div>
+</div>