docyard 0.0.1 → 0.1.0

data/lib/docyard/rack_application.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require "json"
+require "rack"
+
+module Docyard
+  class RackApplication
+    def initialize(docs_path:, file_watcher:)
+      @docs_path = docs_path
+      @file_watcher = file_watcher
+      @router = Router.new(docs_path: docs_path)
+      @renderer = Renderer.new
+      @asset_handler = AssetHandler.new
+    end
+
+    def call(env)
+      handle_request(env)
+    end
+
+    private
+
+    attr_reader :docs_path, :file_watcher, :router, :renderer, :asset_handler
+
+    def handle_request(env)
+      path = env["PATH_INFO"]
+
+      return handle_reload_check(env) if path == "/_docyard/reload"
+      return asset_handler.serve(path) if path.start_with?("/assets/")
+
+      handle_documentation_request(path)
+    rescue StandardError => e
+      handle_error(e)
+    end
+
+    def handle_documentation_request(path)
+      file_path = router.resolve(path)
+      status = file_path ? 200 : 404
+      html = file_path ? renderer.render_file(file_path) : renderer.render_not_found
+
+      [status, { "Content-Type" => "text/html; charset=utf-8" }, [html]]
+    end
+
+    def handle_reload_check(env)
+      query = Rack::Utils.parse_query(env["QUERY_STRING"])
+      since = query["since"] ? Time.at(query["since"].to_f) : Time.now
+      reload_needed = file_watcher.changed_since?(since)
+
+      build_reload_response(reload_needed)
+    rescue StandardError => e
+      puts "[Docyard] Reload check error: #{e.message}"
+      build_reload_response(false)
+    end
+
+    def build_reload_response(reload_needed)
+      response_body = { reload: reload_needed, timestamp: Time.now.to_f }.to_json
+      [200, { "Content-Type" => "application/json" }, [response_body]]
+    end
+
+    def handle_error(error)
+      [500, { "Content-Type" => "text/html; charset=utf-8" }, [renderer.render_server_error(error)]]
+    end
+  end
+end

data/lib/docyard/renderer.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require "erb"
+
+module Docyard
+  class Renderer
+    LAYOUTS_PATH = File.join(__dir__, "templates", "layouts")
+    ERRORS_PATH = File.join(__dir__, "templates", "errors")
+
+    attr_reader :layout_path
+
+    def initialize(layout: "default")
+      @layout_path = File.join(LAYOUTS_PATH, "#{layout}.html.erb")
+    end
+
+    def render_file(file_path)
+      markdown_content = File.read(file_path)
+      markdown = Markdown.new(markdown_content)
+
+      html_content = strip_md_from_links(markdown.html)
+
+      render(
+        content: html_content,
+        page_title: markdown.title || "Documentation"
+      )
+    end
+
+    def render(content:, page_title: "Documentation")
+      template = File.read(layout_path)
+
+      @content = content
+      @page_title = page_title
+
+      ERB.new(template).result(binding)
+    end
+
+    def render_not_found
+      render_error_template(404)
+    end
+
+    def render_server_error(error)
+      @error_message = error.message
+      @backtrace = error.backtrace.join("\n")
+      render_error_template(500)
+    end
+
+    def render_error_template(status)
+      error_template_path = File.join(ERRORS_PATH, "#{status}.html.erb")
+      template = File.read(error_template_path)
+      ERB.new(template).result(binding)
+    end
+
+    private
+
+    def strip_md_from_links(html)
+      html.gsub(/href="([^"]+)\.md"/, 'href="\1"')
+    end
+  end
+end

data/lib/docyard/router.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Docyard
+  class Router
+    attr_reader :docs_path
+
+    def initialize(docs_path:)
+      @docs_path = docs_path
+    end
+
+    def resolve(request_path)
+      clean_path = request_path.delete_prefix("/")
+      clean_path = "index" if clean_path.empty?
+
+      clean_path = clean_path.delete_suffix(".md")
+
+      file_path = File.join(docs_path, "#{clean_path}.md")
+      return file_path if File.file?(file_path)
+
+      index_path = File.join(docs_path, clean_path, "index.md")
+      return index_path if File.file?(index_path)
+
+      nil
+    end
+  end
+end

data/lib/docyard/server.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+require "webrick"
+require "stringio"
+require_relative "file_watcher"
+require_relative "rack_application"
+
+module Docyard
+  class Server
+    DEFAULT_PORT = 4200
+    DEFAULT_HOST = "localhost"
+
+    attr_reader :port, :host, :docs_path
+
+    def initialize(port: DEFAULT_PORT, host: DEFAULT_HOST, docs_path: "docs")
+      @port = port
+      @host = host
+      @docs_path = docs_path
+      @file_watcher = FileWatcher.new(File.expand_path(docs_path))
+      @app = RackApplication.new(
+        docs_path: File.expand_path(docs_path),
+        file_watcher: @file_watcher
+      )
+    end
+
+    def start
+      validate_docs_directory!
+      print_server_info
+      @file_watcher.start
+
+      http_server.mount_proc("/") { |req, res| handle_request(req, res) }
+      trap("INT") { shutdown_server }
+
+      http_server.start
+      @file_watcher.stop
+    end
+
+    private
+
+    def validate_docs_directory!
+      return if File.directory?(docs_path)
+
+      abort "Error: #{docs_path}/ directory not found.\n" \
+            "Run `docyard init` first to create the docs structure."
+    end
+
+    def print_server_info
+      puts "Starting Docyard server..."
+      puts "=> Serving docs from: #{docs_path}/"
+      puts "=> Running at: http://#{host}:#{port}"
+      puts "=> Press Ctrl+C to stop\n"
+    end
+
+    def shutdown_server
+      puts "\nShutting down server..."
+      http_server.shutdown
+    end
+
+    def http_server
+      @http_server ||= WEBrick::HTTPServer.new(
+        Port: port,
+        BindAddress: host,
+        AccessLog: [],
+        Logger: WEBrick::Log.new(File::NULL)
+      )
+    end
+
+    def handle_request(req, res)
+      env = build_rack_env(req)
+      status, headers, body = @app.call(env)
+
+      res.status = status
+      headers.each { |key, value| res[key] = value }
+      body.each { |chunk| res.body << chunk }
+    end
+
+    def build_rack_env(req)
+      {
+        "REQUEST_METHOD" => req.request_method,
+        "PATH_INFO" => req.path,
+        "QUERY_STRING" => req.query_string || "",
+        "SERVER_NAME" => req.host,
+        "SERVER_PORT" => req.port.to_s,
+        "rack.version" => Rack::VERSION,
+        "rack.url_scheme" => "http",
+        "rack.input" => StringIO.new,
+        "rack.errors" => $stderr
+      }
+    end
+  end
+end

data/lib/docyard/templates/assets/css/main.css

@@ -0,0 +1,4 @@
+body {
+	margin: 0;
+	font-family: system-ui, -apple-system, sans-serif;
+}

data/lib/docyard/templates/assets/css/syntax.css

@@ -0,0 +1,116 @@
+.highlight table td { padding: 5px; }
+.highlight table pre { margin: 0; }
+.highlight, .highlight .w {
+  color: #24292f;
+  background-color: #f6f8fa;
+}
+.highlight .k, .highlight .kd, .highlight .kn, .highlight .kp, .highlight .kr, .highlight .kt, .highlight .kv {
+  color: #cf222e;
+}
+.highlight .gr {
+  color: #f6f8fa;
+}
+.highlight .gd {
+  color: #82071e;
+  background-color: #ffebe9;
+}
+.highlight .nb {
+  color: #953800;
+}
+.highlight .nc {
+  color: #953800;
+}
+.highlight .no {
+  color: #953800;
+}
+.highlight .nn {
+  color: #953800;
+}
+.highlight .sr {
+  color: #116329;
+}
+.highlight .na {
+  color: #116329;
+}
+.highlight .nt {
+  color: #116329;
+}
+.highlight .gi {
+  color: #116329;
+  background-color: #dafbe1;
+}
+.highlight .ges {
+  font-weight: bold;
+  font-style: italic;
+}
+.highlight .kc {
+  color: #0550ae;
+}
+.highlight .l, .highlight .ld, .highlight .m, .highlight .mb, .highlight .mf, .highlight .mh, .highlight .mi, .highlight .il, .highlight .mo, .highlight .mx {
+  color: #0550ae;
+}
+.highlight .sb {
+  color: #0550ae;
+}
+.highlight .bp {
+  color: #0550ae;
+}
+.highlight .ne {
+  color: #0550ae;
+}
+.highlight .nl {
+  color: #0550ae;
+}
+.highlight .py {
+  color: #0550ae;
+}
+.highlight .nv, .highlight .vc, .highlight .vg, .highlight .vi, .highlight .vm {
+  color: #0550ae;
+}
+.highlight .o, .highlight .ow {
+  color: #0550ae;
+}
+.highlight .gh {
+  color: #0550ae;
+  font-weight: bold;
+}
+.highlight .gu {
+  color: #0550ae;
+  font-weight: bold;
+}
+.highlight .s, .highlight .sa, .highlight .sc, .highlight .dl, .highlight .sd, .highlight .s2, .highlight .se, .highlight .sh, .highlight .sx, .highlight .s1, .highlight .ss {
+  color: #0a3069;
+}
+.highlight .nd {
+  color: #8250df;
+}
+.highlight .nf, .highlight .fm {
+  color: #8250df;
+}
+.highlight .err {
+  color: #f6f8fa;
+  background-color: #82071e;
+}
+.highlight .c, .highlight .ch, .highlight .cd, .highlight .cm, .highlight .cp, .highlight .cpf, .highlight .c1, .highlight .cs {
+  color: #6e7781;
+}
+.highlight .gl {
+  color: #6e7781;
+}
+.highlight .gt {
+  color: #6e7781;
+}
+.highlight .ni {
+  color: #24292f;
+}
+.highlight .si {
+  color: #24292f;
+}
+.highlight .ge {
+  color: #24292f;
+  font-style: italic;
+}
+.highlight .gs {
+  color: #24292f;
+  font-weight: bold;
+}

data/lib/docyard/templates/assets/js/reload.js

@@ -0,0 +1,98 @@
+(function () {
+  let lastCheck = Date.now() / 1000;
+  let basePollInterval = 500;
+  let currentPollInterval = basePollInterval;
+  let isReloading = false;
+  let consecutiveFailures = 0;
+  let serverWasDown = false;
+  let timeoutId = null;
+
+  async function fetchWithTimeout(resource, options = {}) {
+    const { timeout = 5000 } = options;
+
+    const controller = new AbortController();
+    const id = setTimeout(() => controller.abort(), timeout);
+
+    try {
+      const response = await fetch(resource, {
+        ...options,
+        signal: controller.signal
+      });
+      clearTimeout(id);
+      return response;
+    } catch (error) {
+      clearTimeout(id);
+      throw error;
+    }
+  }
+
+  async function checkForChanges() {
+    if (isReloading) return;
+
+    try {
+      const response = await fetchWithTimeout(`/_docyard/reload?since=${lastCheck}`, { timeout: 3000 });
+      const data = await response.json();
+      lastCheck = data.timestamp;
+
+      if (consecutiveFailures > 0) {
+        consecutiveFailures = 0;
+        currentPollInterval = basePollInterval;
+        if (serverWasDown) {
+          console.log('[Docyard] Server reconnected');
+          serverWasDown = false;
+        }
+      }
+
+      if (data.reload && !isReloading) {
+        isReloading = true;
+        console.log("[Docyard] Changes detected, hot reloading...");
+
+        try {
+          const resp = await fetchWithTimeout(window.location.href, { timeout: 5000 });
+          const html = await resp.text();
+          const parser = new DOMParser();
+          const newDoc = parser.parseFromString(html, 'text/html');
+
+          const oldMain = document.querySelector('main');
+          const newMain = newDoc.querySelector('main');
+
+          if (oldMain && newMain) {
+            oldMain.innerHTML = newMain.innerHTML;
+            console.log('[Docyard] Content updated via hot reload');
+          } else {
+            console.log('[Docyard] Layout changed, full reload required');
+            window.location.reload();
+            return;
+          }
+
+          isReloading = false;
+        } catch (error) {
+          console.error('[Docyard] Hot reload failed:', error);
+          console.log('[Docyard] Falling back to full reload');
+          window.location.reload();
+        }
+      }
+    } catch (error) {
+      consecutiveFailures++;
+
+      if (consecutiveFailures === 1) {
+        console.log('[Docyard] Server disconnected - live reload paused');
+        serverWasDown = true;
+      }
+
+      if (consecutiveFailures >= 3) {
+        console.log('[Docyard] Stopped polling. Refresh page when server restarts.');
+        return;
+      }
+
+      currentPollInterval = Math.min(basePollInterval * Math.pow(2, consecutiveFailures - 1), 5000);
+
+      isReloading = false;
+    }
+
+    timeoutId = setTimeout(checkForChanges, currentPollInterval);
+  }
+
+  checkForChanges();
+  console.log("[Docyard] Hot reload initialized");
+})();

data/lib/docyard/templates/assets/js/theme.js

@@ -0,0 +1 @@
+console.log('Docyard loaded');

data/lib/docyard/templates/errors/404.html.erb

@@ -0,0 +1,16 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  <title>404 - Page Not Found</title>
+  <link rel="stylesheet" href="/assets/css/main.css">
+</head>
+<body>
+  <main>
+    <h1>404 - Page Not Found</h1>
+    <p>The page you're looking for doesn't exist.</p>
+    <p><a href="/">Go back home</a></p>
+  </main>
+</body>
+</html>

data/lib/docyard/templates/errors/500.html.erb

@@ -0,0 +1,25 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  <title>500 - Server Error</title>
+  <link rel="stylesheet" href="/assets/css/main.css">
+</head>
+<body>
+  <main>
+    <h1>500 - Internal Server Error</h1>
+    <p>Something went wrong.</p>
+
+    <% if @error_message %>
+      <h3>Error Details:</h3>
+      <pre><%= @error_message %></pre>
+    <% end %>
+
+    <% if @backtrace %>
+      <h3>Backtrace:</h3>
+      <pre><%= @backtrace %></pre>
+    <% end %>
+  </main>
+</body>
+</html>

data/lib/docyard/templates/layouts/default.html.erb

@@ -0,0 +1,29 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+<meta charset="UTF-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title><%= @page_title || 'Documentation' %></title>
+<link rel="stylesheet" href="/assets/css/main.css">
+<link rel="stylesheet" href="/assets/css/syntax.css">
+</head>
+<body>
+<header>
+    <h1>Documentation</h1>
+</header>
+
+<nav>
+    <!-- Sidebar will go here -->
+</nav>
+
+<main>
+    <%= @content %>
+</main>
+
+<footer>
+    <p>Built with Docyard</p>
+</footer>
+
+<script src="/assets/js/reload.js"></script>
+</body>
+</html>

data/lib/docyard/templates/markdown/getting-started.md.erb

@@ -0,0 +1,40 @@
+---
+title: Getting Started
+description: Learn how to use Docyard
+---
+
+# Getting Started
+
+Welcome! This guide will help you get started with Docyard.
+
+## Writing Documentation
+
+Just write markdown files in the `docs/` folder.
+
+### Frontmatter
+
+Each markdown file can have YAML frontmatter:
+
+```yaml
+---
+title: Page Title
+description: Page description
+---
+
+Markdown Syntax
+
+Docyard supports all standard markdown:
+
+- Bold text
+- Italic text
+- Code snippets
+- Links and images
+- Code blocks with syntax highlighting
+
+Next Steps
+
+- Add more markdown files to docs/
+- Organize files into folders
+- Customize your site with docyard.yml
+
+Happy documenting! 📚

data/lib/docyard/templates/markdown/index.md.erb

@@ -0,0 +1,22 @@
+---
+title: Home
+description: Welcome to your documentation site
+---
+
+# Welcome to Docyard!
+
+This is your documentation homepage. Edit this file to customize it.
+
+## What is Docyard?
+
+Docyard is a beautiful, zero-config documentation generator built with Ruby.
+
+## Quick Start
+
+1. Edit the markdown files in `docs/`
+2. Run `docyard serve` to preview your site
+3. Run `docyard build` to generate static HTML
+
+## Learn More
+
+Check out the [Getting Started](getting-started.md) guide.

data/lib/docyard/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Docyard
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/lib/docyard.rb

@@ -1,8 +1,14 @@
 # frozen_string_literal: true
 
 require_relative "docyard/version"
+require_relative "docyard/cli"
+require_relative "docyard/initializer"
+require_relative "docyard/markdown"
+require_relative "docyard/router"
+require_relative "docyard/renderer"
+require_relative "docyard/asset_handler"
+require_relative "docyard/server"
 
 module Docyard
   class Error < StandardError; end
-  # Your code goes here...
 end