yard-markdown 0.4 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3df94167400db27cf5f4262cc1ac0b800b36108356092de9cb7329805ea113e4
-  data.tar.gz: e962872fd8536827202d6488497ef698bf7484a95880d0539edb6f6428546d32
+  metadata.gz: 56b8294ee2ef9bdd12b36f03b4260286e34d2002363a4f9cd280af85743c342c
+  data.tar.gz: f8df2867ca6d8c98aa79a20585d181b79ed12a507637b948708010ae2930ffe4
 SHA512:
-  metadata.gz: '08cddd7156921c807a951fe1774857178be755bf915cea81fa3c288bdc8e3b8f2a9c66fd5bf7a2b5ea1db33729e8524b95c400ec8f049dc49887fdac279b2f35'
-  data.tar.gz: 86f49d74fd82a79e31acaf8524d473eea7d96fac7012975fc957bff4d9f88101f6ca65ca51e9d0da348a789c6c09c1803806f34b4123c17308f04762875884b5
+  metadata.gz: 5d814cb9ac75d6330b72bbd53087fbc417392aa44296944da168f4195b7d92a9d60ff5e5e40d233ad628763c2c7d9cdb9c99213dde740dd54478791fce1bdacd
+  data.tar.gz: 1aba7f70acf91dca5f5b2a829160ff255a60a598360ccfce492d6cd2096a3d110095fb1eac6bf38138fab808ed98cc6b8b517598acd71a69cc658e235b47012e

data/README.md

@@ -6,7 +6,6 @@ Yard plugin to generate markdown documentation
 - Compatible with Github Flavored Markdown
 - Mimick yard html layout where it makes sense to maintain familiarity
 - Produce .csv index file alonside markdown documentation to act as file index
-- Include markdown files that are already present in source code.
 
 ## Usage
 Yard doesn't load plugin by default, so you need to load plugin through `~/.yard/config`:
@@ -26,13 +25,13 @@ gem install yard-markdown
 Run `yardoc --format=markdown` to generate markdown documentation.
 
 ## Backstory
-This is a successor to [rdoc-mardown gem](https://github.com/skatkov/rdoc-markdown/tree/main/example) with small differences in implementation. This gem was written to power API documentation browser CLI app for ruby developers called [POSH TUI](https://poshtui.com).
+This is a successor to [rdoc-mardown gem](https://github.com/skatkov/rdoc-markdown/tree/main/example). These docsets are used in [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.
 
-Testing Rdoc conversion to markdown:
-  `yardoc example_rdoc.rb` -> outputs everything into example/ folder.
+### Testing Rdoc conversion to markdown:
+`yardoc example_rdoc.rb` -> outputs everything into example/ folder.
 
-Testing Yard conversion to markdown:
+### Testing Yard conversion to markdown:
   `yardoc example_yard.rb` -> outputs everything into example/ folder.

data/example/Aquatic.md

@@ -8,13 +8,11 @@ A mixin for aquatic creatures.
 ## swim() [](#method-i-swim)
 Swim in the water.
 
-**return** [void] 
+**@return** [void] 
 
 
 # Constants
-## DEFAULT_SALMON_SPEED [](#constant-DEFAULT_SALMON_SPEED)
-
-
-## MAX_DEPTH [](#constant-MAX_DEPTH)
-
-
+| Name | Default Value |
+| ---  | ---   |
+| [DEFAULT_SALMON_SPEED](#constant-DEFAULT_SALMON_SPEED) | 20 |
+| [MAX_DEPTH](#constant-MAX_DEPTH) | 500 |

data/example/Fish.md

@@ -9,27 +9,25 @@ The base class for all fish.
 ## make_sound() [](#method-i-make_sound)
 Make a sound.
 
-**return** [void] 
-**yield** [sound] The sound produced by the fish
-**yieldparam** [String] The actual sound
+**@return** [void] 
+**@yield** [sound] The sound produced by the fish
+**@yieldparam** [String] The actual sound
 ## swim(direction, speed) [](#method-i-swim)
 Swim in a specific direction.
 
 Swimming is the most critical feature of fish.
 
-**param** [Symbol, String] The direction to swim
-**param** [Integer] The speed at which to swim
-**return** [Boolean] Whether the swim was successful
+**@param** [Symbol, String] The direction to swim
+**@param** [Integer] The speed at which to swim
+**@return** [Boolean] Whether the swim was successful
 
-**example**
+**@example**
 ```ruby
 swim(:north, 30)
 ```
 
 # Constants
-## DEFAULT_SALMON_SPEED [](#constant-DEFAULT_SALMON_SPEED)
-
-
-## MAX_DEPTH [](#constant-MAX_DEPTH)
-
-
+| Name | Default Value |
+| ---  | ---   |
+| [DEFAULT_SALMON_SPEED](#constant-DEFAULT_SALMON_SPEED) | 20 |
+| [MAX_DEPTH](#constant-MAX_DEPTH) | 500 |

data/example/Salmon.md

@@ -19,40 +19,38 @@ A salmon is an Aquatic Fish.
 ## initialize(farmed, wild) [](#method-i-initialize)
 Creates a new salmon.
 
-**param** [Boolean] Whether the salmon is farmed
-**param** [Boolean] Whether the salmon is wild
-**return** [Salmon] a new instance of Salmon
+**@param** [Boolean] Whether the salmon is farmed
+**@param** [Boolean] Whether the salmon is wild
+**@return** [Salmon] a new instance of Salmon
 ## make_sound() [](#method-i-make_sound)
 Salmon overrides generic implementation.
 
-**return** [void] 
-**yield** [sound] The sound produced by the salmon
-**yieldparam** [String] The actual sound
+**@return** [void] 
+**@yield** [sound] The sound produced by the salmon
+**@yieldparam** [String] The actual sound
 ## sustainable?() [](#method-i-sustainable?)
 Checks if this salmon is sustainable.
 
-**return** [Boolean] Whether the salmon is sustainable
+**@return** [Boolean] Whether the salmon is sustainable
 ## swim() [](#method-i-swim)
 Swim in the water.
 
-**return** [void] 
+**@return** [void] 
 
 # Public Class Methods
 ## wild_salmon() [](#method-c-wild_salmon)
-**return** [Array<Salmon>] List of all wild salmon
+**@return** [Array<Salmon>] List of all wild salmon
 
 # Attributes
 ## farmed[RW] [](#attribute-i-farmed)
 
-**return** [Boolean] True for farmed salmon
+**@return** [Boolean] True for farmed salmon
 ## wild[RW] [](#attribute-i-wild)
 
-**return** [Boolean] True for wild salmon
+**@return** [Boolean] True for wild salmon
 
 # Constants
-## DEFAULT_SALMON_SPEED [](#constant-DEFAULT_SALMON_SPEED)
-
-
-## MAX_DEPTH [](#constant-MAX_DEPTH)
-
-
+| Name | Default Value |
+| ---  | ---   |
+| [DEFAULT_SALMON_SPEED](#constant-DEFAULT_SALMON_SPEED) | 20 |
+| [MAX_DEPTH](#constant-MAX_DEPTH) | 500 |

data/example_yard.rb

@@ -1,12 +1,5 @@
-# @title YARD Markdown Example
-# @description This example demonstrates various YARD features using markdown formatting.
-#
-# ## Links
-#
-# 1. [YARD Documentation](https://yardoc.org/)
-# 2. [Markdown Syntax](https://daringfireball.net/projects/markdown/syntax)
-
 # A mixin for aquatic creatures.
+#
 module Aquatic
   # Swim in the water.
   #
@@ -135,11 +128,9 @@ class Salmon < Fish
   end
 end
 
-# @!constant [Integer] DEFAULT_SALMON_SPEED
-#   Default speed for a swimming salmon
+# Default speed for a swimming salmon
 DEFAULT_SALMON_SPEED = 20
 
-# @!constant [Integer] MAX_DEPTH
 #   Maximum depth for salmon habitat
 MAX_DEPTH = 500
 

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

@@ -126,9 +126,7 @@ def serialize(object)
 ## <%= item.name(false) %>(<%= item.parameters.map {|p| p.join(" ") }.join(", ") %>) [](#<%=aref(item)%>)
 <%= rdoc_to_md item.docstring %>
 <%= render_tags item %>
-
-<% end %>
-<% end %>
+<% end %><% end %>
 <% if (attrs = attr_listing(object)).size > 0 %>
 # Attributes
 <% attrs.each do |item|%>
@@ -136,19 +134,16 @@ def serialize(object)
 <%= rdoc_to_md item.docstring %>
 
 <%= render_tags item %>
-<% end %>
-<% end %>
-
+<% end %><% end %>
 <% if constant_listing.size > 0 %>
 <% groups(constant_listing, "Constants") do |list, name| %>
 # <%= name %>
+<% if list.size > 0 %>
+| Name | Default Value |
+| ---  | ---   |
 <% list.each do |cnst| %>
-## <%= cnst.name %> [](#<%=aref(cnst)%>)
-<%= rdoc_to_md cnst.docstring %>
-
-<%= render_tags cnst %>
-
-<% end %><% end %><% end %>',
+| [<%= cnst.name %>](#<%=aref(cnst)%>) | <%= cnst.value %> |
+<% end %><% end %><% end %><% end %>',
       trim_mode: "<>",
     )
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yard-markdown
 version: !ruby/object:Gem::Version
-  version: '0.4'
+  version: 0.4.1
 platform: ruby
 authors:
 - Stanislav (Stas) Katkov