Overview

• module Utopia
  • module Project

    Provides project documentation generation and rendering.

    • class Base

      Provides structured access to a project directory which contains source code and guides.
    • class Document

      Represents a Markdown document with optional source code cross-references.
    • class Guide

      Provides structured access to a directory which contains documentation and source code to explain a specific process.
    • class Guides

      A collection of guides with navigation and lookup capabilities.
    • class Inheritance

      Resolves relationships and inherited methods for a definition.
    • class Linkify < Decode::Syntax::Rewriter

      Rewrites source code as HTML with links to indexed definitions.
    • class ReleasesDocument < Document

      Represents project release notes organized by release headings.

      • class Summary

        Represents a section within a release.
      • class Release

        Represents a single release and its notes.
    • class Renderer < Markly::Renderer::HTML

      Renders project Markdown with support for Mermaid code blocks.
    • class Sidebar

      Generates a sidebar navigation from markdown document headings.

      • class Entry

        Represents a sidebar navigation entry with title, level, and anchor.