yard-markdown 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6ff780c12b0efc36b1ba7c766ac4a8645d5fa9c5776e6ac1351a064b797e4fd1
-  data.tar.gz: fb42ed6ee07c97cd22af57267b0aed1570b7fb9fe89a4840a643fe4858d4a2a5
+  metadata.gz: dd90bdd01f08225188020b4f84a23b978c37416b6b0081c65056c10c5040d3e6
+  data.tar.gz: 548d5b5cd91b4e95d9f212d18aa8c3a24c8c9be71c256cfda226ecd8ba5cdd61
 SHA512:
-  metadata.gz: d0ff4417bb45236c042daece82cf8442840d0f9c573a6be70e513c5c603ca813dc07ce8d30a5ddad0707463d95e9ac8a548f3f476bde5b777aaf4a27d16e91dd
-  data.tar.gz: 9687a9283bd08e6b5be2d00f0da4f2c41b997a71ef2875c0090aa15ccc78f0ea77d1710b9aba5b63775f2c34efe58dacc668adf9ded49453cbc9a1e575eb04ed
+  metadata.gz: fc7dff8536243860024a82e98eb8a0a26057f0db61aef58431302d73058372dcb206cbca9ea926e94c879b43113caf1065c4bd8cd06af6a78b9d501e5da810f2
+  data.tar.gz: b7cda956cf500503d138d9eeba8d336dce374605870334b28df162fd61c0d2a539603bf8f40518ca0e9b659a0303a224a4238e154b923ec681be72c5956eec0f

data/README.md

@@ -1,14 +1,27 @@
 # Yard::Markdown
 
-Yard-markdown produces markdown documents for ruby gems.
+Yard theme plugin that generates markdown documentation for gems
 
-Goals:
+## Goals:
 - Compatible with Github Flavored Markdown
 - Mimick yard html layout in markdown format as much as possible
-- Produce .csv index file alonside markdown documentation
+- Produce .csv index file alonside markdown documentation to act as file index
 
-This is a successor to rdoc-mardown gem, so it will very likely be similar to this [example](https://github.com/skatkov/rdoc-markdown/tree/main/example).
+## Usage
+Add these lines:
+```
+gem 'yard-markdown'
+```
+And run `bundle install`
 
+Run yardoc with `--format=markdown` parameter.
 
-Testing:
-  `yardoc example.rb` -> outputs everything into doc.
+## Backstory
+Successor to rdoc-mardown gem that was authored by me. So there is a lot of similarities between two - [example](https://github.com/skatkov/rdoc-markdown/tree/main/example).
+
+This gem is used by documentation reviewing tool called [POSH TUI](https://poshtui.com)
+
+## Testing
+Unit tests can't really test this gem properly. So it's semi-manual process of making changes and reviewing output.
+
+  `yardoc example.rb` -> outputs everything into example/ folder.

data/example/Bird.md

@@ -34,3 +34,4 @@ Produce some noise.
 --
 FIXME: maybe extract this to a base class +Animal+?
 ++
+

data/example/Duck.md

@@ -5,7 +5,7 @@
 | **Extended by:** | Animal |
 | **Includes:** | Waterfowl |
 | **Defined in:**    | example.rb    |
-|| |
+
 
 A duck is a Waterfowl Bird.
 

data/lib/yard/markdown/version.rb

@@ -2,6 +2,6 @@
 
 module YARD
   module Markdown
-    VERSION = "0.1.0"
+    VERSION = "0.1.1"
   end
 end

data/lib/yard-markdown.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+dir = File.dirname(__FILE__)
+$LOAD_PATH.unshift dir unless $LOAD_PATH.include?(dir)
+
+require "yard"
+require_relative "markdown/version"
+
+module YARD
+  module Markdown
+  end
+end
+
+puts "YARD::Markdown loaded"
+YARD::Templates::Engine.register_template_path dir + '/../templates'

data/templates/default/fulldoc/markdown/setup.rb

@@ -2,7 +2,6 @@
 
 # https://github.com/lsegal/yard/blob/2d197a381c5d4cc5c55b2c60fff992b31c986361/docs/CodeObjects.md
 
-require_relative "../../../../lib/yard/serializers/markdown_serializer"
 require "erb"
 
 def init

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yard-markdown
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Stanislav (Stas) Katkov
@@ -9,8 +9,22 @@ autorequire:
 bindir: exe
 cert_chain: []
 date: 2023-11-26 00:00:00.000000000 Z
-dependencies: []
-description: yard-markdown is a yard plugin template to generate markdown files
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: yard theme plugin that generates markdown documentation for gems
 email:
 - yard-markdown@skatkov.com
 executables: []
@@ -27,11 +41,9 @@ files:
 - example/Bird.md
 - example/Duck.md
 - example/Waterfowl.md
-- lib/yard/markdown.rb
+- lib/yard-markdown.rb
 - lib/yard/markdown/version.rb
-- lib/yard/serializers/markdown_serializer.rb
 - sig/yard/markdown.rbs
-- templates/default/fulldoc/markdown/content.erb
 - templates/default/fulldoc/markdown/setup.rb
 homepage: https://poshtui.com
 licenses:
@@ -54,8 +66,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.20
+rubygems_version: 3.4.22
 signing_key:
 specification_version: 4
-summary: yard-markdown is a yard plugin template to generate markdown files
+summary: yard theme plugin that generates markdown documentation for gems
 test_files: []

data/lib/yard/markdown.rb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-require "yard"
-require_relative "markdown/version"
-require_relative "serializers/markdown_serializer"
-
-module YARD
-  module Markdown
-    YARD::Templates::Engine.register_template_path "/../../templates"
-  end
-end

data/lib/yard/serializers/markdown_serializer.rb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-module YARD
-  module Serializers
-    class MarkdownSerializer < YARD::Serializers::FileSystemSerializer
-      def initialize(opts = {})
-        super(opts.merge(extension: "md"))
-      end
-    end
-  end
-end

data/templates/default/fulldoc/markdown/content.erb

@@ -1,2 +0,0 @@
-# Test
-<%= @object.docstring %>