Module: DocsKit

Defined in:
lib/docs_kit.rb,
lib/docs_kit/engine.rb,
lib/docs_kit/version.rb,
lib/docs_kit/nav_item.rb,
lib/docs_kit/open_api.rb,
lib/docs_kit/registry.rb,
lib/docs_kit/shortcut.rb,
lib/docs_kit/llms_text.rb,
lib/docs_kit/mcp_tools.rb,
lib/docs_kit/api_client.rb,
lib/docs_kit/controller.rb,
lib/docs_kit/mcp_server.rb,
lib/docs_kit/search_hit.rb,
lib/docs_kit/seo_config.rb,
lib/docs_kit/api_request.rb,
lib/docs_kit/topbar_link.rb,
lib/docs_kit/og_generator.rb,
lib/docs_kit/search_index.rb,
lib/docs_kit/api_templates.rb,
lib/docs_kit/configuration.rb,
lib/docs_kit/landing_config.rb,
lib/docs_kit/markdown_export.rb,
lib/docs_kit/open_api/schema.rb,
lib/docs_kit/open_api/document.rb,
lib/docs_kit/open_api/operation.rb,
lib/docs_kit/search_index/snippet.rb,
lib/docs_kit/markdown_export/table.rb,
lib/docs_kit/markdown_export/blocks.rb,
lib/docs_kit/markdown_export/inline.rb,
app/controllers/docs_kit/mcp_controller.rb,
app/controllers/docs_kit/llms_controller.rb,
app/controllers/docs_kit/search_controller.rb,
lib/generators/docs_kit/install/sync_report.rb,
lib/generators/docs_kit/page/page_generator.rb,
lib/generators/docs_kit/install/install_generator.rb

Overview

DocsKit — a reusable docs-site component library: the shared Phlex chrome (shell, sidebar, code block, theme switcher, page kit) that lets several docs sites look identical while differing only in configuration.

Components live under the Docs:: namespace and are exposed as a Phlex::Kit, so a host base view can include Docs and call Shell(...), Page(...), Code(...), etc., or always use the namespaced render Docs::Shell.new(...).

Defined Under Namespace

Modules: ApiTemplates, Controller, Generators, LlmsText, McpServer, McpTools, OpenApi, Registry Classes: ApiClient, ApiRequest, Configuration, Engine, Error, LandingConfig, LlmsController, MarkdownExport, McpController, NavItem, OgGenerator, SearchController, SearchHit, SearchIndex, SeoConfig, Shortcut, TopbarLink

Constant Summary collapse

VERSION = 
"1.0.6"

Class Method Summary collapse

Class Method Details

.configuration ⇒ Object

The current configuration, memoized. Reset with DocsKit.reset_configuration!.



22
23
24
 
# File 'lib/docs_kit.rb', line 22

def configuration
  @configuration ||= Configuration.new
end

.configure {|configuration| ... } ⇒ Object

Yields:



26
27
28
29
 
# File 'lib/docs_kit.rb', line 26

def configure
  yield(configuration)
  configuration
end

.reset_configuration! ⇒ Object 



31
32
33
 
# File 'lib/docs_kit.rb', line 31

def reset_configuration!
  @configuration = Configuration.new
end