opaque_id 1.1.0 → 1.3.0

data/docs/_config.yml

@@ -0,0 +1,162 @@
+# Site settings
+title: OpaqueId Documentation
+description: Generate cryptographically secure, collision-free opaque IDs for ActiveRecord models
+url: "https://nyaggah.github.io"
+baseurl: "/opaque_id"
+
+# Just the Docs theme (via remote_theme for GitHub Pages compatibility)
+remote_theme: just-the-docs/just-the-docs
+
+# GitHub Pages plugins
+plugins:
+  - jekyll-feed
+  - jekyll-sitemap
+  - jekyll-seo-tag
+  - jekyll-remote-theme
+
+# Feed configuration
+feed:
+  posts_limit: 10
+  excerpt_only: true
+  path: "feed.xml"
+
+# Sitemap configuration
+sitemap:
+  changefreq: "weekly"
+  priority: 0.5
+  lastmod: true
+
+# Site metadata
+author: Joe Nyaggah
+github_username: nyaggah
+repository: nyaggah/opaque_id
+
+# SEO and social metadata
+lang: en
+locale: en_US
+keywords: ruby, rails, activerecord, opaque-id, nanoid, secure-random, documentation, gem, id-generation, cryptography
+social:
+  name: OpaqueId
+  links:
+    - https://github.com/nyaggah/opaque_id
+    - https://rubygems.org/gems/opaque_id
+
+# SEO configuration
+seo:
+  type: "WebSite"
+  name: "OpaqueId Documentation"
+  description: "Generate cryptographically secure, collision-free opaque IDs for ActiveRecord models"
+  url: "https://nyaggah.github.io/opaque_id"
+  image: "https://nyaggah.github.io/opaque_id/assets/images/og-image.png"
+  twitter:
+    card: "summary_large_image"
+    site: "@nyaggah"
+    creator: "@nyaggah"
+  facebook:
+    app_id: ""
+    publisher: ""
+  google:
+    site_verification: ""
+
+# Permalinks
+permalink: pretty
+collections:
+  docs:
+    output: true
+    permalink: /:collection/:name/
+
+# Just the Docs configuration
+search_enabled: true
+search_tokenizer_separator: /[\s/]+/
+search_placeholder: "Search docs"
+search_show_title: true
+
+# Theme customization
+masthead_title: "OpaqueId"
+masthead_title_url: "/"
+masthead_title_image: false
+
+# Syntax highlighting
+highlighter: rouge
+markdown: kramdown
+kramdown:
+  syntax_highlighter: rouge
+  syntax_highlighter_opts:
+    css_class: "highlight"
+    span:
+      line_numbers: false
+    block:
+      line_numbers: false
+      start_line: 1
+
+# Custom head includes
+head_scripts:
+  - |
+    <style>
+      /* Custom favicon */
+      <link rel="icon" type="image/svg+xml" href="/opaque_id/assets/images/favicon.svg">
+      <link rel="icon" type="image/png" href="/opaque_id/assets/images/favicon.png">
+    </style>
+
+# Navigation
+nav_external_links: true
+nav_external_links_new_tab: true
+nav_footer: true
+nav_order: 1
+
+# Header and footer
+header_links:
+  - title: "GitHub"
+    url: "https://github.com/nyaggah/opaque_id"
+  - title: "RubyGems"
+    url: "https://rubygems.org/gems/opaque_id"
+
+# Auxiliary links (moved to sidebar top)
+aux_links:
+  - title: "GitHub"
+    url: "https://github.com/nyaggah/opaque_id"
+  - title: "RubyGems"
+    url: "https://rubygems.org/gems/opaque_id"
+  - title: "Issues"
+    url: "https://github.com/nyaggah/opaque_id/issues"
+  - title: "Releases"
+    url: "https://github.com/nyaggah/opaque_id/releases"
+
+# Color scheme - use system theme with light fallback
+color_scheme: light
+
+# Custom CSS
+sass:
+  sass_dir: assets/css
+  style: compressed
+
+# Performance optimizations
+compress_html:
+  clippings: all
+  comments: all
+  endings: all
+  startings: [html, head, body]
+  blanklines: false
+  profile: false
+  ignore:
+    envs: all
+
+# Asset optimization
+keep_files:
+  - assets/images
+
+# Footer - using custom include for dynamic year
+footer_content: false
+
+# Exclude from processing
+exclude:
+  - .sass-cache/
+  - .jekyll-cache/
+  - gemfiles/
+  - Gemfile
+  - Gemfile.lock
+  - node_modules/
+  - vendor/bundle/
+  - vendor/cache/
+  - vendor/gems/
+  - vendor/ruby/

data/docs/_data/navigation.yml

@@ -0,0 +1,132 @@
+# Custom navigation structure for OpaqueId documentation
+# This file provides additional navigation metadata and organization
+
+# Main navigation sections
+main:
+  - title: "Getting Started"
+    url: "/getting-started/"
+    description: "Quick start guide and basic setup"
+    icon: "play"
+
+  - title: "Installation"
+    url: "/installation/"
+    description: "Installation methods and requirements"
+    icon: "download"
+
+  - title: "Usage"
+    url: "/usage/"
+    description: "How to use OpaqueId in your application"
+    icon: "code"
+
+# Configuration section
+configuration:
+  - title: "Configuration"
+    url: "/configuration/"
+    description: "Configuration options and examples"
+    icon: "settings"
+
+  - title: "Alphabets"
+    url: "/alphabets/"
+    description: "Built-in alphabets and custom options"
+    icon: "type"
+
+# Technical section
+technical:
+  - title: "Algorithms"
+    url: "/algorithms/"
+    description: "Technical details of ID generation algorithms"
+    icon: "cpu"
+
+  - title: "Performance"
+    url: "/performance/"
+    description: "Benchmarks and optimization tips"
+    icon: "zap"
+
+  - title: "Security"
+    url: "/security/"
+    description: "Security considerations and best practices"
+    icon: "shield"
+
+# Reference section
+reference:
+  - title: "Use Cases"
+    url: "/use-cases/"
+    description: "Real-world examples and applications"
+    icon: "lightbulb"
+
+  - title: "API Reference"
+    url: "/api-reference/"
+    description: "Complete API documentation"
+    icon: "book"
+
+  - title: "Development"
+    url: "/development/"
+    description: "Contributing and development setup"
+    icon: "tools"
+
+# External links
+external:
+  - title: "GitHub Repository"
+    url: "https://github.com/nyaggah/opaque_id"
+    description: "Source code and issue tracking"
+    icon: "github"
+
+  - title: "RubyGems"
+    url: "https://rubygems.org/gems/opaque_id"
+    description: "Install from RubyGems"
+    icon: "package"
+
+  - title: "Report Issue"
+    url: "https://github.com/nyaggah/opaque_id/issues"
+    description: "Report bugs or request features"
+    icon: "bug"
+
+# Quick links for common tasks
+quick_links:
+  - title: "Quick Start"
+    url: "/getting-started/"
+    description: "Get up and running in 5 minutes"
+
+  - title: "Installation"
+    url: "/installation/"
+    description: "Install the gem"
+
+  - title: "Basic Usage"
+    url: "/usage/"
+    description: "Generate your first opaque ID"
+
+  - title: "Configuration"
+    url: "/configuration/"
+    description: "Customize ID generation"
+
+  - title: "API Reference"
+    url: "/api-reference/"
+    description: "Complete method documentation"
+
+# Related projects and resources
+related:
+  - title: "NanoID (Original)"
+    url: "https://github.com/ai/nanoid"
+    description: "The original NanoID implementation"
+
+  - title: "nanoid.rb"
+    url: "https://github.com/radeno/nanoid.rb"
+    description: "Ruby port of NanoID"
+
+  - title: "PlanetScale Article"
+    url: "https://planetscale.com/blog/why-we-chose-nanoids-for-planetscales-api"
+    description: "Why we chose NanoIDs for PlanetScale's API"
+
+# Footer links
+footer:
+  - title: "License"
+    url: "https://github.com/nyaggah/opaque_id/blob/main/LICENSE.txt"
+    description: "MIT License"
+
+  - title: "Code of Conduct"
+    url: "https://github.com/nyaggah/opaque_id/blob/main/CODE_OF_CONDUCT.md"
+    description: "Contributor Covenant"
+
+  - title: "Changelog"
+    url: "https://github.com/nyaggah/opaque_id/blob/main/CHANGELOG.md"
+    description: "Version history"

data/docs/_includes/footer_custom.html

@@ -0,0 +1,8 @@
+<!-- Custom footer with dynamic year -->
+<footer class="site-footer">
+  <div class="site-footer-content">
+    <p class="text-small text-grey-dk-100 mb-0">
+      Copyright © {{ 'now' | date: '%Y' }} Joe Nyaggah. Distributed by an MIT license.
+    </p>
+  </div>
+</footer>

data/docs/_includes/head_custom.html

@@ -0,0 +1,67 @@
+<!-- Custom head includes for OpaqueId Documentation -->
+
+<!-- Favicon -->
+<link rel="icon" type="image/svg+xml" href="{{ '/assets/images/favicon.svg' | relative_url }}">
+<link rel="icon" type="image/png" href="{{ '/assets/images/favicon.png' | relative_url }}">
+<link rel="apple-touch-icon" href="{{ '/assets/images/apple-touch-icon.png' | relative_url }}">
+
+<!-- Open Graph / Facebook -->
+<meta property="og:type" content="website">
+<meta property="og:url" content="{{ site.url }}{{ site.baseurl }}{{ page.url }}">
+<meta property="og:title" content="{% if page.title %}{{ page.title }} - {% endif %}{{ site.title }}">
+<meta property="og:description" content="{% if page.description %}{{ page.description }}{% else %}{{ site.description }}{% endif %}">
+<meta property="og:image" content="{{ site.url }}{{ site.baseurl }}/assets/images/og-image.png">
+<meta property="og:site_name" content="{{ site.title }}">
+
+<!-- Twitter -->
+<meta property="twitter:card" content="summary_large_image">
+<meta property="twitter:url" content="{{ site.url }}{{ site.baseurl }}{{ page.url }}">
+<meta property="twitter:title" content="{% if page.title %}{{ page.title }} - {% endif %}{{ site.title }}">
+<meta property="twitter:description" content="{% if page.description %}{{ page.description }}{% else %}{{ site.description }}{% endif %}">
+<meta property="twitter:image" content="{{ site.url }}{{ site.baseurl }}/assets/images/og-image.png">
+<meta property="twitter:site" content="@nyaggah">
+<meta property="twitter:creator" content="@nyaggah">
+
+<!-- Additional SEO meta tags -->
+<meta name="robots" content="index, follow">
+<meta name="googlebot" content="index, follow">
+<meta name="author" content="{{ site.author }}">
+<meta name="generator" content="Jekyll {{ jekyll.version }}">
+<meta name="theme-color" content="#a855f7">
+<meta name="msapplication-TileColor" content="#a855f7">
+<meta name="msapplication-config" content="{{ '/assets/images/browserconfig.xml' | relative_url }}">
+
+<!-- Canonical URL -->
+<link rel="canonical" href="{{ site.url }}{{ site.baseurl }}{{ page.url }}">
+
+<!-- JSON-LD structured data -->
+<script type="application/ld+json">
+{
+  "@context": "https://schema.org",
+  "@type": "WebSite",
+  "name": "{{ site.title }}",
+  "description": "{{ site.description }}",
+  "url": "{{ site.url }}{{ site.baseurl }}",
+  "author": {
+    "@type": "Person",
+    "name": "{{ site.author }}",
+    "url": "https://github.com/{{ site.github_username }}"
+  },
+  "publisher": {
+    "@type": "Organization",
+    "name": "{{ site.title }}",
+    "url": "{{ site.url }}{{ site.baseurl }}"
+  },
+  "potentialAction": {
+    "@type": "SearchAction",
+    "target": "{{ site.url }}{{ site.baseurl }}/search/?q={search_term_string}",
+    "query-input": "required name=search_term_string"
+  }
+}
+</script>
+
+<!-- Additional performance optimizations -->
+<link rel="preconnect" href="https://fonts.googleapis.com">
+<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
+<link rel="dns-prefetch" href="//github.com">
+<link rel="dns-prefetch" href="//rubygems.org">