docyard 0.1.0 → 0.2.0

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

@@ -1,22 +1,86 @@
----
-title: Home
-description: Welcome to your documentation site
----
+# Welcome to Docyard
 
-# Welcome to Docyard!
+A modern, zero-config documentation generator for Ruby developers.
 
-This is your documentation homepage. Edit this file to customize it.
+## Features
 
-## What is Docyard?
-
-Docyard is a beautiful, zero-config documentation generator built with Ruby.
+- **Auto-generated Navigation** - Sidebar built from your folder structure
+- **Hot Reload** - Changes appear instantly while you write
+- **GitHub Flavored Markdown** - Full GFM support with tables and task lists
+- **Syntax Highlighting** - 100+ languages powered by Rouge
+- **Zero Configuration** - Works out of the box with sensible defaults
+- **Mobile Responsive** - Beautiful on desktop, tablet, and mobile
 
 ## 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
+Get up and running in under a minute:
+
+```bash
+# Install
+gem install docyard
+
+# Initialize
+docyard init
+
+# Start dev server
+docyard serve
+```
+
+Visit `http://localhost:4200` to see your docs.
+
+
+## Example Code
+
+Ruby with syntax highlighting:
+
+```ruby
+class DocumentationSite
+  attr_reader :title, :pages
+
+  def initialize(title)
+    @title = title
+    @pages = []
+  end
+
+  def add_page(path, content)
+    pages << { path: path, content: content }
+  end
+
+  def build
+    pages.each { |page| render_page(page) }
+  end
+end
+```
+
+
+JavaScript example:
+
+```javascript
+function buildDocs(config) {
+  const { title, theme } = config;
+  console.log(`Building ${title} with ${theme} theme`);
+  return { success: true };
+}
+```
+
+## Documentation Structure
+
+| Section | Description |
+|---------|-------------|
+| Getting Started | Installation and quick start guide |
+| Core Concepts | Learn about file structure and markdown |
+
+## What's Next?
+
+> Get started by exploring the documentation in the sidebar, or jump straight to the [Quick Start Guide](getting-started/quick-start).
+
+### Learn the Basics
+
+1. [Introduction](getting-started/introduction) - Learn what Docyard can do
+2. [Installation](getting-started/installation) - Install Docyard on your system
+3. [Quick Start](getting-started/quick-start) - Create your first site
 
-## Learn More
+### Understand Core Concepts
 
-Check out the [Getting Started](getting-started.md) guide.
+- [File Structure](core-concepts/file-structure) - How to organize your docs
+- [Markdown](core-concepts/markdown) - Supported markdown features

data/lib/docyard/templates/partials/_icons.html.erb

@@ -0,0 +1,11 @@
+<%# External link icon %>
+<% if @icon_name == :external %>
+  <svg class="external-icon" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
+    <path d="M224,104a8,8,0,0,1-16,0V59.32l-66.33,66.34a8,8,0,0,1-11.32-11.32L196.68,48H152a8,8,0,0,1,0-16h64a8,8,0,0,1,8,8Zm-40,24a8,8,0,0,0-8,8v72H48V80h72a8,8,0,0,0,0-16H48A16,16,0,0,0,32,80V208a16,16,0,0,0,16,16H176a16,16,0,0,0,16-16V136A8,8,0,0,0,184,128Z" />
+  </svg>
+<%# Chevron icon %>
+<% elsif @icon_name == :chevron %>
+  <svg class="nav-group-icon" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 256 256" fill="currentColor">
+    <path d="M181.66,133.66l-80,80a8,8,0,0,1-11.32-11.32L164.69,128,90.34,53.66a8,8,0,0,1,11.32-11.32l80,80A8,8,0,0,1,181.66,133.66Z"/>
+  </svg>
+<% end %>

data/lib/docyard/templates/partials/_nav_group.html.erb

@@ -0,0 +1,7 @@
+<button class="nav-group-toggle" aria-expanded="true" type="button">
+  <span><%= @title %></span>
+  <%= icon(:chevron) %>
+</button>
+<div class="nav-group-children">
+  <%= @children_html %>
+</div>

data/lib/docyard/templates/partials/_nav_item.html.erb

@@ -0,0 +1,3 @@
+<li>
+  <%= @item_content %>
+</li>

data/lib/docyard/templates/partials/_nav_leaf.html.erb

@@ -0,0 +1 @@
+<a href="<%= @path %>"<%= ' class="active"' if @active %>><%= @title %></a>

data/lib/docyard/templates/partials/_nav_list.html.erb

@@ -0,0 +1,3 @@
+<ul>
+  <%= @list_items %>
+</ul>

data/lib/docyard/templates/partials/_nav_section.html.erb

@@ -0,0 +1,6 @@
+<div class="nav-section">
+  <% if @section_name %>
+    <div class="nav-section-title"><%= @section_name %></div>
+  <% end %>
+  <%= @section_content %>
+</div>

data/lib/docyard/templates/partials/_sidebar.html.erb

@@ -0,0 +1,6 @@
+<aside class="sidebar" role="navigation" aria-label="Documentation navigation">
+  <nav>
+    <%= @nav_content %>
+  </nav>
+  <%= @footer_html %>
+</aside>

data/lib/docyard/templates/partials/_sidebar_footer.html.erb

@@ -0,0 +1,11 @@
+<div class="sidebar-footer">
+  <a href="https://github.com/sanifhimani/docyard"
+     target="_blank"
+     rel="noopener noreferrer"
+     class="sidebar-footer-link">
+    <div class="sidebar-footer-text">
+      <p class="sidebar-footer-title">Built with Docyard</p>
+    </div>
+    <%= icon(:external) %>
+  </a>
+</div>

data/lib/docyard/utils/path_resolver.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Docyard
+  module Utils
+    class PathResolver
+      def self.normalize(path)
+        return "/" if path.nil? || path.empty?
+
+        normalized = path.delete_suffix(".md")
+          .delete_suffix("/index")
+
+        normalized = "" if normalized == "index"
+
+        normalized = "/" if normalized.empty?
+        normalized = "/#{normalized}" unless normalized.start_with?("/")
+        normalized
+      end
+
+      def self.to_url(relative_path)
+        normalize(relative_path)
+      end
+
+      def self.ancestor?(parent_path, child_path)
+        return false if parent_path.nil?
+
+        child_path.start_with?(parent_path) && child_path != parent_path
+      end
+    end
+  end
+end

data/lib/docyard/utils/text_formatter.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Docyard
+  module Utils
+    class TextFormatter
+      def self.titleize(string)
+        return "Home" if string == "index"
+
+        string.gsub(/[-_]/, " ")
+          .split
+          .map(&:capitalize)
+          .join(" ")
+      end
+
+      def self.slugify(string)
+        string.downcase
+          .gsub(/\s+/, "-")
+          .gsub(/[^a-z0-9-]/, "")
+      end
+    end
+  end
+end

data/lib/docyard/version.rb

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

data/lib/docyard.rb

@@ -1,14 +1,26 @@
 # frozen_string_literal: true
 
+# Core modules
 require_relative "docyard/version"
-require_relative "docyard/cli"
-require_relative "docyard/initializer"
-require_relative "docyard/markdown"
+require_relative "docyard/constants"
+require_relative "docyard/errors"
+require_relative "docyard/logging"
+
+# Utilities
+require_relative "docyard/utils/text_formatter"
+require_relative "docyard/utils/path_resolver"
+
+# Routing
+require_relative "docyard/routing/resolution_result"
 require_relative "docyard/router"
+
+# Application components
+require_relative "docyard/markdown"
 require_relative "docyard/renderer"
 require_relative "docyard/asset_handler"
+require_relative "docyard/initializer"
 require_relative "docyard/server"
+require_relative "docyard/cli"
 
 module Docyard
-  class Error < StandardError; end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: docyard
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Sanif Himani
@@ -142,22 +142,51 @@ files:
 - lib/docyard.rb
 - lib/docyard/asset_handler.rb
 - lib/docyard/cli.rb
+- lib/docyard/constants.rb
+- lib/docyard/errors.rb
 - lib/docyard/file_watcher.rb
 - lib/docyard/initializer.rb
+- lib/docyard/logging.rb
 - lib/docyard/markdown.rb
 - lib/docyard/rack_application.rb
 - lib/docyard/renderer.rb
 - lib/docyard/router.rb
+- lib/docyard/routing/resolution_result.rb
 - lib/docyard/server.rb
+- lib/docyard/sidebar/file_system_scanner.rb
+- lib/docyard/sidebar/renderer.rb
+- lib/docyard/sidebar/title_extractor.rb
+- lib/docyard/sidebar/tree_builder.rb
+- lib/docyard/sidebar_builder.rb
+- lib/docyard/templates/assets/css/code.css
+- lib/docyard/templates/assets/css/components.css
+- lib/docyard/templates/assets/css/layout.css
 - lib/docyard/templates/assets/css/main.css
-- lib/docyard/templates/assets/css/syntax.css
+- lib/docyard/templates/assets/css/markdown.css
+- lib/docyard/templates/assets/css/reset.css
+- lib/docyard/templates/assets/css/typography.css
+- lib/docyard/templates/assets/css/variables.css
 - lib/docyard/templates/assets/js/reload.js
 - lib/docyard/templates/assets/js/theme.js
 - lib/docyard/templates/errors/404.html.erb
 - lib/docyard/templates/errors/500.html.erb
 - lib/docyard/templates/layouts/default.html.erb
-- lib/docyard/templates/markdown/getting-started.md.erb
+- lib/docyard/templates/markdown/core-concepts/file-structure.md.erb
+- lib/docyard/templates/markdown/core-concepts/markdown.md.erb
+- lib/docyard/templates/markdown/getting-started/installation.md.erb
+- lib/docyard/templates/markdown/getting-started/introduction.md.erb
+- lib/docyard/templates/markdown/getting-started/quick-start.md.erb
 - lib/docyard/templates/markdown/index.md.erb
+- lib/docyard/templates/partials/_icons.html.erb
+- lib/docyard/templates/partials/_nav_group.html.erb
+- lib/docyard/templates/partials/_nav_item.html.erb
+- lib/docyard/templates/partials/_nav_leaf.html.erb
+- lib/docyard/templates/partials/_nav_list.html.erb
+- lib/docyard/templates/partials/_nav_section.html.erb
+- lib/docyard/templates/partials/_sidebar.html.erb
+- lib/docyard/templates/partials/_sidebar_footer.html.erb
+- lib/docyard/utils/path_resolver.rb
+- lib/docyard/utils/text_formatter.rb
 - lib/docyard/version.rb
 - sig/docyard.rbs
 homepage: https://github.com/sanifhimani/docyard

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

@@ -1,116 +0,0 @@
-.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/markdown/getting-started.md.erb

@@ -1,40 +0,0 @@
----
-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! 📚