docyard 0.2.0 → 0.3.0

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

@@ -0,0 +1,202 @@
+---
+title: Configuration
+---
+
+# Configuration
+
+Docyard uses convention over configuration. You can start using Docyard without any configuration file - it just works!
+
+## Optional Configuration
+
+Create a `docyard.yml` file in your project root to customize your documentation site.
+
+```yaml
+site:
+  title: "My Documentation"
+  description: "Documentation for my project"
+
+build:
+  output_dir: "dist"
+  base_url: "/"
+```
+
+## Configuration Reference
+
+### Site Settings
+
+Configure your site metadata and branding.
+
+#### `site.title`
+
+The title of your documentation site. Shown in the browser tab and header.
+
+- **Type:** String
+- **Default:** `"Documentation"`
+
+```yaml
+site:
+  title: "My Project Docs"
+```
+
+#### `site.description`
+
+Meta description for SEO and social sharing.
+
+- **Type:** String
+- **Default:** `""`
+
+```yaml
+site:
+  description: "Complete documentation for My Project"
+```
+
+#### `site.logo`
+
+Path to your logo image. Displayed in the site header.
+
+- **Type:** String (file path)
+- **Default:** None
+- **Supported formats:** SVG, PNG, JPG
+
+```yaml
+site:
+  logo: "docs/assets/logo.svg"
+```
+
+::: tip
+Use SVG format for your logo for best quality at all screen sizes.
+:::
+
+#### `site.logo_dark`
+
+Optional dark mode variant of your logo.
+
+- **Type:** String (file path)
+- **Default:** None
+
+```yaml
+site:
+  logo: "docs/assets/logo.svg"
+  logo_dark: "docs/assets/logo-dark.svg"
+```
+
+#### `site.favicon`
+
+Path to your favicon.
+
+- **Type:** String (file path)
+- **Default:** None
+- **Supported formats:** `.ico`, `.png`
+
+```yaml
+site:
+  favicon: "docs/assets/favicon.ico"
+```
+
+### Build Settings
+
+Configure static site generation.
+
+#### `build.output_dir`
+
+Directory where the built site will be generated.
+
+- **Type:** String
+- **Default:** `"dist"`
+- **Note:** Cannot contain slashes
+
+```yaml
+build:
+  output_dir: "dist"  # or "_site", "public", etc.
+```
+
+#### `build.base_url`
+
+Base URL for your site. Important for subdirectory deployments.
+
+- **Type:** String
+- **Default:** `"/"`
+- **Note:** Must start with `/`
+
+```yaml
+# For root deployment
+build:
+  base_url: "/"
+
+# For GitHub Pages project site
+build:
+  base_url: "/my-repo/"
+```
+
+::: important
+Set `base_url` correctly for subdirectory deployments (like GitHub Pages project sites) or your assets won't load correctly.
+:::
+
+#### `build.clean`
+
+Whether to clean the output directory before building.
+
+- **Type:** Boolean
+- **Default:** `true`
+
+```yaml
+build:
+  clean: true  # Recommended
+```
+
+## Examples
+
+### Basic Configuration
+
+Minimal config with just a custom title:
+
+```yaml
+site:
+  title: "Acme Documentation"
+```
+
+### Full Branding
+
+Complete branding with logo and favicon:
+
+```yaml
+site:
+  title: "Acme Inc."
+  description: "API documentation for Acme services"
+  logo: "docs/assets/logo.svg"
+  logo_dark: "docs/assets/logo-dark.svg"
+  favicon: "docs/assets/favicon.ico"
+```
+
+### GitHub Pages Deployment
+
+Configuration for GitHub Pages subdirectory:
+
+```yaml
+site:
+  title: "My Project"
+
+build:
+  base_url: "/my-repo/"
+```
+
+### Custom Output Directory
+
+Using a different output directory:
+
+```yaml
+build:
+  output_dir: "public"
+  base_url: "/"
+```
+
+## No Configuration Required
+
+If you don't create a `docyard.yml` file, Docyard will work with sensible defaults:
+
+- Site title: `"Documentation"`
+- Output directory: `dist/`
+- Base URL: `/`
+- Clean build: `true`
+
+This means you can run `docyard serve` immediately after `docyard init` without any additional configuration!

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

@@ -0,0 +1,11 @@
+<div class="docyard-callout docyard-callout--<%= @type %>" role="<%= %w[danger warning].include?(@type) ? 'alert' : 'note' %>">
+  <div class="docyard-callout__icon" aria-hidden="true">
+    <%= @icon_svg %>
+  </div>
+  <div class="docyard-callout__content">
+    <div class="docyard-callout__title"><%= @title %></div>
+    <div class="docyard-callout__body">
+      <%= @content_html %>
+    </div>
+  </div>
+</div>

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

@@ -0,0 +1,6 @@
+<div class="docyard-code-block">
+  <%= @code_block_html %>
+  <button class="docyard-code-block__copy" aria-label="Copy code to clipboard" data-code="<%= @code_text %>">
+    <%= @copy_icon %>
+  </button>
+</div>

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

@@ -0,0 +1 @@
+<span class="docyard-icon docyard-icon-<%= @name %>" aria-hidden="true"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 256 256" fill="currentColor"><%= @icon_data %></svg></span>

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

@@ -0,0 +1 @@
+<span class="docyard-icon docyard-icon-file-<%= @extension %>" aria-hidden="true"><%= @svg_content %></span>

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

@@ -0,0 +1,40 @@
+<div class="docyard-tabs" data-tabs="<%= @group_id %>">
+  <div class="docyard-tabs__list-wrapper">
+    <div role="tablist" aria-label="Code examples" class="docyard-tabs__list">
+      <% @tabs.each_with_index do |tab, index| %>
+        <button
+          role="tab"
+          aria-selected="<%= index == 0 ? 'true' : 'false' %>"
+          aria-controls="tabpanel-<%= @group_id %>-<%= index %>"
+          id="tab-<%= @group_id %>-<%= index %>"
+          class="docyard-tabs__tab"
+          tabindex="<%= index == 0 ? '0' : '-1' %>"
+        >
+          <% if tab[:icon] %>
+            <span class="docyard-tabs__icon">
+              <% if tab[:icon_source] == "file-extension" %>
+                <%= Docyard::Icons.render_file_extension(tab[:icon]) %>
+              <% elsif tab[:icon_source] == "phosphor" %>
+                <%= Docyard::Icons.render(tab[:icon]) %>
+              <% end %>
+            </span>
+          <% end %>
+          <%= tab[:name] %>
+        </button>
+      <% end %>
+      <div class="docyard-tabs__indicator" aria-hidden="true"></div>
+    </div>
+  </div>
+  <% @tabs.each_with_index do |tab, index| %>
+    <div
+      role="tabpanel"
+      id="tabpanel-<%= @group_id %>-<%= index %>"
+      aria-labelledby="tab-<%= @group_id %>-<%= index %>"
+      aria-hidden="<%= index == 0 ? 'false' : 'true' %>"
+      class="docyard-tabs__panel"
+      tabindex="0"
+    >
+      <%= tab[:content] %>
+    </div>
+  <% end %>
+</div>

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

@@ -0,0 +1,13 @@
+<button class="theme-toggle" aria-label="Toggle theme" title="Toggle theme">
+  <span class="theme-toggle-track">
+    <!-- Sun icon -->
+    <svg class="theme-toggle-icon theme-toggle-sun-icon" xmlns="http://www.w3.org/2000/svg" width="14" height="14" viewBox="0 0 256 256" fill="currentColor">
+      <path d="M120,40V16a8,8,0,0,1,16,0V40a8,8,0,0,1-16,0Zm72,88a64,64,0,1,1-64-64A64.07,64.07,0,0,1,192,128Zm-16,0a48,48,0,1,0-48,48A48.05,48.05,0,0,0,176,128ZM58.34,69.66A8,8,0,0,0,69.66,58.34l-16-16A8,8,0,0,0,42.34,53.66Zm0,116.68-16,16a8,8,0,0,0,11.32,11.32l16-16a8,8,0,0,0-11.32-11.32ZM192,72a8,8,0,0,0,5.66-2.34l16-16a8,8,0,0,0-11.32-11.32l-16,16A8,8,0,0,0,192,72Zm5.66,114.34a8,8,0,0,0-11.32,11.32l16,16a8,8,0,0,0,11.32-11.32ZM48,128a8,8,0,0,0-8-8H16a8,8,0,0,0,0,16H40A8,8,0,0,0,48,128Zm80,80a8,8,0,0,0-8,8v24a8,8,0,0,0,16,0V216A8,8,0,0,0,128,208Zm112-88H216a8,8,0,0,0,0,16h24a8,8,0,0,0,0-16Z"></path>
+    </svg>
+    <!-- Moon stars icon -->
+    <svg class="theme-toggle-icon theme-toggle-moon-icon" xmlns="http://www.w3.org/2000/svg" width="14" height="14" viewBox="0 0 256 256" fill="currentColor">
+      <path d="M240,96a8,8,0,0,1-8,8H216v16a8,8,0,0,1-16,0V104H184a8,8,0,0,1,0-16h16V72a8,8,0,0,1,16,0V88h16A8,8,0,0,1,240,96ZM144,56h8v8a8,8,0,0,0,16,0V56h8a8,8,0,0,0,0-16h-8V32a8,8,0,0,0-16,0v8h-8a8,8,0,0,0,0,16Zm72.77,97a8,8,0,0,1,1.43,8A96,96,0,1,1,95.07,37.8a8,8,0,0,1,10.6,9.06A88.07,88.07,0,0,0,209.14,150.33,8,8,0,0,1,216.77,153Zm-19.39,14.88c-1.79.09-3.59.14-5.38.14A104.11,104.11,0,0,1,88,64c0-1.79,0-3.59.14-5.38A80,80,0,1,0,197.38,167.86Z"></path>
+    </svg>
+    <span class="theme-toggle-thumb"></span>
+  </span>
+</button>

data/lib/docyard/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: docyard
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Sanif Himani
@@ -137,15 +137,32 @@ files:
 - CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
 - LICENSE.txt
+- LICENSE.vscode-icons
 - README.md
 - Rakefile
 - lib/docyard.rb
 - lib/docyard/asset_handler.rb
 - lib/docyard/cli.rb
+- lib/docyard/components/base_processor.rb
+- lib/docyard/components/callout_processor.rb
+- lib/docyard/components/code_block_processor.rb
+- lib/docyard/components/code_detector.rb
+- lib/docyard/components/icon_detector.rb
+- lib/docyard/components/icon_processor.rb
+- lib/docyard/components/registry.rb
+- lib/docyard/components/tabs_parser.rb
+- lib/docyard/components/tabs_processor.rb
+- lib/docyard/config.rb
+- lib/docyard/config/validator.rb
 - lib/docyard/constants.rb
 - lib/docyard/errors.rb
 - lib/docyard/file_watcher.rb
+- lib/docyard/icons.rb
+- lib/docyard/icons/LICENSE.phosphor
+- lib/docyard/icons/file_types.rb
+- lib/docyard/icons/phosphor.rb
 - lib/docyard/initializer.rb
+- lib/docyard/language_mapping.rb
 - lib/docyard/logging.rb
 - lib/docyard/markdown.rb
 - lib/docyard/rack_application.rb
@@ -159,24 +176,44 @@ files:
 - 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/components/callout.css
+- lib/docyard/templates/assets/css/components/code-block.css
+- lib/docyard/templates/assets/css/components/icon.css
+- lib/docyard/templates/assets/css/components/logo.css
+- lib/docyard/templates/assets/css/components/navigation.css
+- lib/docyard/templates/assets/css/components/tabs.css
+- lib/docyard/templates/assets/css/components/theme-toggle.css
 - lib/docyard/templates/assets/css/layout.css
 - lib/docyard/templates/assets/css/main.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/favicon.svg
+- lib/docyard/templates/assets/js/components/code-block.js
+- lib/docyard/templates/assets/js/components/tabs.js
 - lib/docyard/templates/assets/js/reload.js
 - lib/docyard/templates/assets/js/theme.js
+- lib/docyard/templates/assets/logo-dark.svg
+- lib/docyard/templates/assets/logo.svg
+- lib/docyard/templates/config/docyard.yml.erb
 - 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/components/callouts.md.erb
+- lib/docyard/templates/markdown/components/icons.md.erb
+- lib/docyard/templates/markdown/components/tabs.md.erb
+- lib/docyard/templates/markdown/configuration.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/_callout.html.erb
+- lib/docyard/templates/partials/_code_block.html.erb
+- lib/docyard/templates/partials/_icon.html.erb
+- lib/docyard/templates/partials/_icon_file_extension.html.erb
 - lib/docyard/templates/partials/_icons.html.erb
 - lib/docyard/templates/partials/_nav_group.html.erb
 - lib/docyard/templates/partials/_nav_item.html.erb
@@ -185,6 +222,8 @@ files:
 - 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/templates/partials/_tabs.html.erb
+- lib/docyard/templates/partials/_theme_toggle.html.erb
 - lib/docyard/utils/path_resolver.rb
 - lib/docyard/utils/text_formatter.rb
 - lib/docyard/version.rb