llm-docs-builder 0.3.0

data/llm-docs-builder.gemspec

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require_relative 'lib/llm_docs_builder/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'llm-docs-builder'
+  spec.version = LlmDocsBuilder::VERSION
+  spec.authors = ['Maciej Mensfeld']
+  spec.email = %w[maciej@mensfeld.pl]
+
+  spec.summary = 'Build and optimize documentation for LLMs - generate llms.txt, transform markdown, and more'
+  spec.description = <<~DESC
+    A comprehensive Ruby tool for building and optimizing documentation for Large Language Models.
+    Features include: generating llms.txt files from documentation directories with automatic file
+    prioritization, transforming individual markdown files by expanding relative links to absolute URLs,
+    bulk transforming entire documentation trees with customizable exclusion patterns, comparing content
+    sizes to measure context window savings, and serving LLM-optimized documentation. Provides both CLI
+    and Ruby API with configuration file support.
+  DESC
+
+  spec.homepage = 'https://github.com/mensfeld/llm-docs-builder'
+  spec.license = 'MIT'
+  spec.required_ruby_version = '>= 3.2'
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/mensfeld/llm-docs-builder'
+  spec.metadata['changelog_uri'] = 'https://github.com/mensfeld/llm-docs-builder/blob/master/CHANGELOG.md'
+  spec.metadata['documentation_uri'] = 'https://github.com/mensfeld/llm-docs-builder'
+  spec.metadata['rubygems_mfa_required'] = 'true'
+
+  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(spec|test)/}) }
+
+  spec.bindir = 'bin'
+  spec.executables = spec.files.grep(%r{\Abin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'zeitwerk', '~> 2.6'
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 1.0'
+  spec.add_development_dependency 'simplecov', '~> 0.21'
+end

data/llm-docs-builder.yml

@@ -0,0 +1,7 @@
+docs: ./docs
+base_url: https://myproject.io
+title: My Awesome Project
+description: A Ruby library that helps developers build amazing applications
+output: llms.txt
+convert_urls: true
+verbose: false

data/llm-docs-builder.yml.example

@@ -0,0 +1,26 @@
+# Example llms-txt.yml configuration file
+# Copy to llms-txt.yml and customize for your project
+
+# Path to documentation directory or file
+docs: ./docs
+
+# Base URL for expanding relative links (optional)
+base_url: https://myproject.io
+
+# Project information (optional - will auto-detect from docs if not provided)
+title: My Awesome Project
+description: A Ruby library that helps developers build amazing applications
+
+# Output file path (optional)
+output: llms.txt
+
+# Transform options (optional)
+convert_urls: true  # Convert .html links to .md
+verbose: false      # Verbose output
+
+# Bulk transformation options (optional)
+suffix: .llm        # Suffix for transformed files (creates file.llm.md)
+excludes:           # Patterns for files to exclude from bulk transformation
+  - "**/private/**"    # Exclude private directories
+  - "**/draft-*.md"    # Exclude draft files
+  - "**/.*"            # Exclude hidden files

data/renovate.json

@@ -0,0 +1,33 @@
+{
+  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+  "extends": [
+    "config:recommended"
+  ],
+  "ignorePaths": [
+    "spec/integrations"
+  ],
+  "github-actions": {
+    "enabled": true,
+    "pinDigests": true
+  },
+  "packageRules": [
+    {
+      "matchCategories": [
+        "ruby"
+      ],
+      "enabled": true
+    },
+    {
+      "matchManagers": [
+        "github-actions"
+      ],
+      "minimumReleaseAge": "7 days"
+    },
+    {
+      "matchManagers": [
+        "bundler"
+      ],
+      "minimumReleaseAge": "7 days"
+    }
+  ]
+}

metadata

@@ -0,0 +1,171 @@
+--- !ruby/object:Gem::Specification
+name: llm-docs-builder
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Maciej Mensfeld
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+description: |
+  A comprehensive Ruby tool for building and optimizing documentation for Large Language Models.
+  Features include: generating llms.txt files from documentation directories with automatic file
+  prioritization, transforming individual markdown files by expanding relative links to absolute URLs,
+  bulk transforming entire documentation trees with customizable exclusion patterns, comparing content
+  sizes to measure context window savings, and serving LLM-optimized documentation. Provides both CLI
+  and Ruby API with configuration file support.
+email:
+- maciej@mensfeld.pl
+executables:
+- llm-docs-builder
+- rspecs
+extensions: []
+extra_rdoc_files: []
+files:
+- ".dockerignore"
+- ".github/workflows/ci.yml"
+- ".github/workflows/docker.yml"
+- ".github/workflows/push.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- ".ruby-version"
+- CHANGELOG.md
+- CLAUDE.md
+- Dockerfile
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/llm-docs-builder
+- bin/rspecs
+- lib/llm_docs_builder.rb
+- lib/llm_docs_builder/bulk_transformer.rb
+- lib/llm_docs_builder/cli.rb
+- lib/llm_docs_builder/comparator.rb
+- lib/llm_docs_builder/config.rb
+- lib/llm_docs_builder/errors.rb
+- lib/llm_docs_builder/generator.rb
+- lib/llm_docs_builder/markdown_transformer.rb
+- lib/llm_docs_builder/parser.rb
+- lib/llm_docs_builder/validator.rb
+- lib/llm_docs_builder/version.rb
+- llm-docs-builder.gemspec
+- llm-docs-builder.yml
+- llm-docs-builder.yml.example
+- renovate.json
+homepage: https://github.com/mensfeld/llm-docs-builder
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/mensfeld/llm-docs-builder
+  source_code_uri: https://github.com/mensfeld/llm-docs-builder
+  changelog_uri: https://github.com/mensfeld/llm-docs-builder/blob/master/CHANGELOG.md
+  documentation_uri: https://github.com/mensfeld/llm-docs-builder
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Build and optimize documentation for LLMs - generate llms.txt, transform
+  markdown, and more
+test_files: []