elder_docs 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 53d1646bb49d2be38dcc43d646f38e63a257e31e3e49e7725ee5b856e88eebcc
+  data.tar.gz: 69f62037def7feea699bfbecf03b91b3769bc40321e86573f498f8bda2d41f8f
+SHA512:
+  metadata.gz: 209001181a6d81f7eaebab82cf9a0b2df905ecc7b00b867bad810c7d20714bec87defd399a1ad58c683702359bcd2dcf46bbaaec08fa90f76c851389d76e1f9e
+  data.tar.gz: 1fd1fa84bb406777bc81cdb8121794cac0c0049cf0df3561615540f8bb3a19e8499561d32c5273d52bfa8d877132b2a18329aa62aea5df0c28914fd956c8d8b1

data/LICENSE.txt

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2024 ElderDocs
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

data/README.md

@@ -0,0 +1,145 @@
+# ElderDocs
+
+Interactive API documentation for Rails. Convert your OpenAPI spec into a beautiful, testable documentation site.
+
+## Features
+
+- 🚀 **Interactive API Explorer** - Test endpoints directly from docs
+- 🎨 **Customizable UI** - Web-based configurator at `/docs/ui`
+- 📖 **Guides & Articles** - Add custom documentation
+- 🔐 **Multiple Auth Types** - Bearer, API Key, Basic, OAuth2
+- ⚡ **Zero Config** - Works out of the box
+
+## Installation
+
+Add to your `Gemfile`:
+
+```ruby
+gem 'elder_docs'
+```
+
+Then:
+
+```bash
+bundle install
+```
+
+## Quick Start
+
+### 1. Create your OpenAPI file
+
+Create `definitions.json` in your Rails root:
+
+```json
+{
+  "openapi": "3.0.0",
+  "info": {
+    "title": "My API",
+    "version": "1.0.0"
+  },
+  "servers": [{"url": "https://api.example.com"}],
+  "paths": {
+    "/users": {
+      "get": {
+        "summary": "List users",
+        "responses": {
+          "200": {"description": "Success"}
+        }
+      }
+    }
+  }
+}
+```
+
+### 2. Create articles (optional)
+
+Create `articles.json`:
+
+```json
+[
+  {
+    "id": "getting_started",
+    "title": "Getting Started",
+    "markdown_content": "## Welcome\n\nYour guide here..."
+  }
+]
+```
+
+### 3. Generate docs
+
+```bash
+bundle exec elderdocs deploy
+```
+
+### 4. Mount in routes
+
+```ruby
+# config/routes.rb
+mount ElderDocs::Engine, at: '/docs'
+```
+
+### 5. Visit
+
+Open `http://localhost:3000/docs` 🎉
+
+## Customize UI
+
+Visit `/docs/ui` to customize fonts, colors, and styling with a visual editor.
+
+**Default password:** `admin` (or set `admin_password` in `elderdocs.yml`)
+
+## Configuration
+
+Create `elderdocs.yml` in your Rails root:
+
+```yaml
+# API server URL
+api_server: https://api.example.com
+
+# Multiple environments
+api_servers:
+  - url: https://api-sandbox.example.com
+    description: Sandbox
+  - url: https://api.example.com
+    description: Production
+
+# Authentication types
+auth_types:
+  - bearer
+  - api_key
+  - basic
+  - oauth2
+
+# UI customization (or use /docs/ui)
+ui:
+  font_heading: 'Syne'
+  font_body: 'IBM Plex Sans'
+  colors:
+    primary: '#f8d447'
+    secondary: '#000000'
+    background: '#ffffff'
+    surface: '#ffffff'
+  corner_radius: '0px'
+
+# Admin password for /docs/ui
+admin_password: your-secure-password
+```
+
+## CLI Options
+
+```bash
+bundle exec elderdocs deploy \
+  --definitions custom.json \
+  --articles guides.json \
+  --api-server https://api.example.com
+```
+
+## Requirements
+
+- Ruby >= 2.7.0
+- Rails >= 6.0
+- Node.js >= 16.0 (for building assets)
+
+## License
+
+MIT

data/elderdocs.yml.example

@@ -0,0 +1,49 @@
+# ElderDocs Configuration File
+# Copy this to elderdocs.yml in your Rails root directory
+
+# Mount path for the documentation (default: /docs)
+# If /docs is already taken, ElderDocs will try: /api-docs, /documentation, /api, /docs/api
+mount_path: /docs
+
+# Admin password for UI configuration page (/docs/ui)
+# Default: 'admin' (or set via ELDERDOCS_ADMIN_PASSWORD environment variable)
+# admin_password: your-secure-password-here
+
+# Default API server URL (overrides OpenAPI servers if set)
+# Leave empty to use the first server from your OpenAPI spec
+# api_server: https://api.example.com
+
+# Or define multiple environments:
+# api_servers:
+#   - url: https://api-sandbox.example.com
+#     description: Sandbox
+#   - url: https://api.example.com
+#     description: Production
+
+# Supported authentication types
+# Options: bearer, api_key, basic, oauth2
+auth_types:
+  - bearer
+  - api_key
+  - basic
+  - oauth2
+
+# UI Customization
+# Customize fonts, colors, and button styles
+ui:
+  # Font families for headings and body text
+  # Available fonts: Syne, Inter, Space Grotesk, Oswald, Fira Code, Roboto, Open Sans, IBM Plex Sans
+  font_heading: 'Syne'        # Font for headings, buttons, and UI elements
+  font_body: 'IBM Plex Sans' # Font for body text and content
+  
+  # Color palette
+  colors:
+    primary: '#f8d447'      # Primary accent color (buttons, highlights) - Bright Yellow
+    secondary: '#000000'    # Secondary color (text, borders) - Black
+    background: '#ffffff'   # Page background color - White
+    surface: '#ffffff'      # Panel/Card background color - White
+  
+  # Corner radius for all UI elements (buttons, cards, inputs)
+  # Examples: '0px' (sharp corners), '8px' (rounded), '99px' (pill-shaped)
+  corner_radius: '0px'
+

data/exe/elderdocs

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative '../lib/elder_docs'
+
+ElderDocs::CLI.start(ARGV)
+