kit-doc
kit-doc

edge

kit-doc edge

Search module
Kit::Doc::Services::Search
View Source

Logic to generate search_items.js file

Link to this section Summary ⚠️ Private APIs are currently hidden.

Defined in: lib/kit/doc/services/search.rb#4

Class methods 6

.clean_content(content:)

.get_search_list(options:, url_generator:, anchor_generator:, verifier_runner:)

.handle_constants(options:, url_generator:, anchor_generator:, verifier_runner:)

Generate search_items output for Constants.
.handle_extras(options:, url_generator:)

Generate search_items output for Extras.
.handle_methods(options:, url_generator:, anchor_generator:, verifier_runner:)

Generate search_items output for Methods.
.handle_modules(options:, url_generator:, anchor_generator:, verifier_runner:)

Generate search_items output for Modules / Classes.

Link to this section Class methods 6

Link to this method

.clean_content(content:)

View Source
Link to this method

.get_search_list(options:, url_generator:, anchor_generator:, verifier_runner:)

View Source
📋 Todos:
  • Add support for finding target method when in parents.
Link to this method

.handle_constants(options:, url_generator:, anchor_generator:, verifier_runner:)

View Source

Generate search_items output for Constants

Link to this method

.handle_extras(options:, url_generator:)

View Source
📋 Todos:
  • handle h1/h2 like ExDoc

Generate search_items output for Extras

Link to this method

.handle_methods(options:, url_generator:, anchor_generator:, verifier_runner:)

View Source

Generate search_items output for Methods

Link to this method

.handle_modules(options:, url_generator:, anchor_generator:, verifier_runner:)

View Source

Generate search_items output for Modules / Classes