source2md 0.0.4 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f611630d43ae94215b726f34b9eb21058b116fc5cd680ba1349888183b0568d
-  data.tar.gz: b77b99e4e0fed12a8ecc1d2b8fec203b9caa88866a25d3649f8c89d0c09bcc28
+  metadata.gz: 45ea284efbf369a44f443d19ad9efef483c50d71b7d0a6a3061e22fd0a844ab4
+  data.tar.gz: f5e5ae8ac1275e92d6a09161f6561e3ca3ed39e13b821d69a3b5ceae53d23467
 SHA512:
-  metadata.gz: e8fa08c336da0fb2873eddc88d114219cd2bde1d1857c637cf9d3fa42ea93a17fa3e724748bdd00e82c9bb8ca97964a6872040f04d99f6a876d71d2f3af9a0c6
-  data.tar.gz: 250194de04ec0531337df28e83d5f7931ddee724fdf375d617a38e9c51e7217a53715f0cfbc2e05a88b220a48841ee86fb412f2e57d8c3f47aa0697077f85202
+  metadata.gz: 9b801b23ca8be860c0f76bbc6e3184b79ee9872b424108b83598dc23362667e00c21eb857c2995698addee97f85bd2995dc421b4f2d6dadd871e7f3db80eb6d0
+  data.tar.gz: 4972b72106e655da9078ce8962eb4bd32fbecccd520c1d7d0bd24b7e1029b6d9fa1aa2775ce9b9a4a980fd7af9d373d35be8c1666d67868eb1a04d5589f036cf

data/README.md

@@ -1,5 +1,11 @@
 # Source2MD: Markdown generator from source code #
 
+## Logic ##
+
+1. Divide the source code into paragraphs using blank lines as separations.
+1. Remove comments from the comment blocks.
+1. Include the code within the code block.
+
 ## Install ##
 
 ```
@@ -14,7 +20,9 @@ $ source2md generate -o README.md README.rb
 
 ## Rules ##
 
-### Embedding Of Small Code ###
+### Code snippet ###
+
+Separated by blank lines.
 
 ```ruby
 puts Source2MD::Section.new(<<~EOS).to_md
@@ -36,7 +44,7 @@ EOS
 > hello.call
 > ```
 
-### Source Block ###
+### Source block with many lines ###
 
 ```ruby
 puts Source2MD::Section.new(<<~EOS).to_md
@@ -58,6 +66,55 @@ EOS
 > hello.call
 > ```
 
+### Hide paragraph ###
+
+```ruby
+puts Source2MD::Section.new(<<~EOS).to_md
+  #+hidden: true
+  p "This paragraph is not displayed"
+EOS
+```
+
+### Code include ###
+
+```ruby
+Insert inside the code block.
+```
+
+```ruby
+File.write("/tmp/hello.html", "<p>Hello</p>")
+
+puts Source2MD::Section.new(<<~EOS).to_md
+  #+code_include: /tmp/hello.html
+
+  #+code_include: /tmp/hello.html xml:OUTPUT
+EOS
+```
+
+> ````
+> ```html:hello.html
+> <p>Hello</p>
+> ```
+>
+> ```xml:OUTPUT
+> <p>Hello</p>
+> ```
+> ````
+
+### Raw include ###
+
+```ruby
+File.write("/tmp/hello.html", "<p>Hello</p>")
+
+puts Source2MD::Section.new(<<~EOS).to_md
+  #+raw_include: /tmp/hello.html
+EOS
+```
+
+> ```
+> <p>Hello</p>
+> ```
+
 ### Title ###
 
 No number limit.
@@ -72,13 +129,15 @@ puts Source2MD::Section.new(<<~EOS).to_md
 EOS
 ```
 
-> # Title Level 1 # #
->
-> ## Title Level 2 # ##
->
-> ### Title Level 3 # ###
+```
+# Title Level 1 #
 
-### Markdown Style Title ###
+## Title Level 2 ##
+
+### Title Level 3 ###
+```
+
+### Markdown style title ###
 
 The condition is that there are the same number of sharps on the back.
 
@@ -92,13 +151,15 @@ puts Source2MD::Section.new(<<~EOS).to_md
 EOS
 ```
 
-> # Title Level 1 #
->
-> ## Title Level 2 ##
->
-> ### Title Level 3 ###
+```
+# Title Level 1 #
+
+## Title Level 2 ##
+
+### Title Level 3 ###
+```
 
-### Org-mode Table Style ###
+### Org-mode table style ###
 
 ```ruby
 puts Source2MD::Section.new(<<~EOS).to_md
@@ -132,7 +193,7 @@ EOS
 > | C++        |  1983 | Bjarne Stroustrup                          |
 > | Python     |  1989 | Guido van Rossum                           |
 
-### Explain the method simply ###
+### Explain method simply ###
 
 ```ruby
 puts Source2MD::Section.new(<<~EOS).to_md
@@ -168,7 +229,7 @@ EOS
 >
 > Comments about reverse
 
-### Warning, Alert Message ###
+### Warning and Alert message ###
 
 Exclusive to Zenn
 
@@ -192,34 +253,50 @@ EOS
 > :::
 > ```
 
-### Text ###
+### Raw Text ###
 
 If no rule applies and the text begins with `#`, remove the `#`.
 
 ```ruby
 puts Source2MD::Section.new(<<~EOS).to_md
-  # Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
-  # Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
+  # Lorem ipsum dolor sit amet, consectetur adipisicing elit,
+  # sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
 EOS
 ```
 
-> Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
-> Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
+> ```
+> Lorem ipsum dolor sit amet, consectetur adipisicing elit,
+> sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
+> ```
 
-### Raw Text ###
+### Oneline Text ###
 
-Same rule as when writing text, simply remove the leading `#`.
+Using this option allows you to split a line regardless of the markdown library.
 
 ```ruby
 puts Source2MD::Section.new(<<~EOS).to_md
-  # <hr>
-  #
-  # <hr>
+  #+oneline: true
+  # Lorem ipsum dolor sit amet, consectetur adipisicing elit,
+  # sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
 EOS
 ```
 
 > ```
-> <hr>
->
-> <hr>
+> Lorem ipsum dolor sit amet, consectetur adipisicing elit,sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
 > ```
+
+### Parse include ###
+
+Paste the results of processing other files with the same rules.
+
+```ruby
+File.write("/tmp/hello.rb", <<~EOS)
+# foo
+EOS
+
+puts Source2MD::Section.new(<<~EOS).to_md
+  #+parse_include: /tmp/hello.rb
+EOS
+```
+
+> foo

data/Rakefile

@@ -9,6 +9,7 @@ task :o => "open"
 namespace :doc do
   desc "[g] generate README.md"
   task "generate" do
+    Rake::Task["doc:renum"].execute
     system "sh", "-vec", <<~EOT, exception: true
 .bin/source2md generate --no-debug --no-xmp-out-exclude -o README.md doc/0*
 EOT

data/doc/0100_top.rb

@@ -1,7 +1,14 @@
+#+hidden: true
 require "./setup"
 
 # Source2MD: Markdown generator from source code #
 
+## Logic ##
+
+# 1. Divide the source code into paragraphs using blank lines as separations.
+# 1. Remove comments from the comment blocks.
+# 1. Include the code within the code block.
+
 ## Install ##
 
 # ```

data/doc/0110_code_small.rb

@@ -1,6 +1,9 @@
+#+hidden: true
 require "./setup"
 
-### Embedding Of Small Code ###
+### Code snippet ###
+
+# Separated by blank lines.
 
 #+BEGIN_SRC
 puts Source2MD::Section.new(<<~EOS).to_md

data/doc/0120_code_long.rb

@@ -1,6 +1,7 @@
+#+hidden: true
 require "./setup"
 
-### Source Block ###
+### Source block with many lines ###
 
 #+BEGIN_SRC
 puts Source2MD::Section.new(<<~EOS).to_md

data/doc/0130_hidden.rb

@@ -0,0 +1,19 @@
+#+hidden: true
+require "./setup"
+
+### Hide paragraph ###
+
+#+BEGIN_SRC
+puts Source2MD::Section.new(<<~EOS).to_md
+  #+hidden: true
+  p "This paragraph is not displayed"
+EOS
+#+END_SRC
+
+#+BEGIN_SRC
+puts Source2MD::Section.new(<<~EOS).to_md
+  #+BEGIN_SRC hidden!
+  p "This paragraph is not displayed"
+  #+END_SRC
+EOS
+#+END_SRC

data/doc/0140_code_include.rb

@@ -0,0 +1,26 @@
+#+hidden: true
+require "./setup"
+
+### Code include ###
+
+Insert inside the code block.
+
+#+BEGIN_SRC
+File.write("/tmp/hello.html", "<p>Hello</p>")
+
+puts Source2MD::Section.new(<<~EOS).to_md
+  #+code_include: /tmp/hello.html
+
+  #+code_include: /tmp/hello.html xml:OUTPUT
+EOS
+#+END_SRC
+
+# > ````
+# > ```html:hello.html
+# > <p>Hello</p>
+# > ```
+# >
+# > ```xml:OUTPUT
+# > <p>Hello</p>
+# > ```
+# > ````

data/doc/0150_raw_include.rb

@@ -0,0 +1,16 @@
+#+hidden: true
+require "./setup"
+
+### Raw include ###
+
+#+BEGIN_SRC
+File.write("/tmp/hello.html", "<p>Hello</p>")
+
+puts Source2MD::Section.new(<<~EOS).to_md
+  #+raw_include: /tmp/hello.html
+EOS
+#+END_SRC
+
+# > ```
+# > <p>Hello</p>
+# > ```

data/doc/{0130_title.rb → 0160_title.rb}

@@ -1,3 +1,4 @@
+#+hidden: true
 require "./setup"
 
 ### Title ###
@@ -14,8 +15,10 @@ puts Source2MD::Section.new(<<~EOS).to_md
 EOS
 #+END_SRC
 
-# > # Title Level 1 # #
-# >
-# > ## Title Level 2 # ##
-# >
-# > ### Title Level 3 # ###
+# ```
+# # Title Level 1 #
+#
+# ## Title Level 2 ##
+#
+# ### Title Level 3 ###
+# ```

data/doc/{0140_md_like_title.rb → 0170_md_like_title.rb}

@@ -1,6 +1,7 @@
+#+hidden: true
 require "./setup"
 
-### Markdown Style Title ###
+### Markdown style title ###
 
 # The condition is that there are the same number of sharps on the back.
 
@@ -14,8 +15,10 @@ puts Source2MD::Section.new(<<~EOS).to_md
 EOS
 #+END_SRC
 
-# > # Title Level 1 #
-# >
-# > ## Title Level 2 ##
-# >
-# > ### Title Level 3 ###
+# ```
+# # Title Level 1 #
+#
+# ## Title Level 2 ##
+#
+# ### Title Level 3 ###
+# ```

data/doc/{0150_table.rb → 0180_table.rb}

@@ -1,6 +1,7 @@
+#+hidden: true
 require "./setup"
 
-### Org-mode Table Style ###
+### Org-mode table style ###
 
 #+BEGIN_SRC
 puts Source2MD::Section.new(<<~EOS).to_md

data/doc/{0160_method.rb → 0190_method.rb}

@@ -1,6 +1,7 @@
+#+hidden: true
 require "./setup"
 
-### Explain the method simply ###
+### Explain method simply ###
 
 #+BEGIN_SRC
 puts Source2MD::Section.new(<<~EOS).to_md

data/doc/{0170_alert.rb → 0200_alert.rb}

@@ -1,6 +1,7 @@
+#+hidden: true
 require "./setup"
 
-### Warning, Alert Message ###
+### Warning and Alert message ###
 
 # Exclusive to Zenn
 

data/doc/0210_text.rb

@@ -0,0 +1,18 @@
+#+hidden: true
+require "./setup"
+
+### Raw Text ###
+
+# If no rule applies and the text begins with `#`, remove the `#`.
+
+#+BEGIN_SRC
+puts Source2MD::Section.new(<<~EOS).to_md
+  # Lorem ipsum dolor sit amet, consectetur adipisicing elit,
+  # sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
+EOS
+#+END_SRC
+
+# > ```
+# > Lorem ipsum dolor sit amet, consectetur adipisicing elit,
+# > sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
+# > ```

data/doc/0220_text_oneline.rb

@@ -0,0 +1,18 @@
+#+hidden: true
+require "./setup"
+
+### Oneline Text ###
+
+# Using this option allows you to split a line regardless of the markdown library.
+
+#+BEGIN_SRC
+puts Source2MD::Section.new(<<~EOS).to_md
+  #+oneline: true
+  # Lorem ipsum dolor sit amet, consectetur adipisicing elit,
+  # sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
+EOS
+#+END_SRC
+
+# > ```
+# > Lorem ipsum dolor sit amet, consectetur adipisicing elit,sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
+# > ```

data/doc/0230_parse_include.rb

@@ -0,0 +1,18 @@
+#+hidden: true
+require "./setup"
+
+### Parse include ###
+
+# Paste the results of processing other files with the same rules.
+
+#+BEGIN_SRC
+File.write("/tmp/hello.rb", <<~EOS)
+# foo
+EOS
+
+puts Source2MD::Section.new(<<~EOS).to_md
+  #+parse_include: /tmp/hello.rb
+EOS
+#+END_SRC
+
+# > foo

data/examples/cli.rb

@@ -1,3 +1,4 @@
+#+hidden: true
 require "./setup"
 
 Source2MD::Generator.new(files: ["input.rb"], output_file: "output.md").call

data/examples/element_text.rb

@@ -1,3 +1,4 @@
+#+hidden: true
 require "./setup"
 
 puts Source2MD::Element.new(<<~EOS).to_md
@@ -5,7 +6,7 @@ puts Source2MD::Element.new(<<~EOS).to_md
 #   https://example.com/
 EOS
 # >> --------------------------------------------------------------------------------
-# >> Source2MD::Type::ElementUncomment
+# >> Source2MD::Part::TypeText
 # >> 
 # >> head:
 # >> {}

data/examples/scanner.rb

@@ -1,3 +1,4 @@
+#+hidden: true
 require "./setup"
 
 Source2MD::Scanner.new(<<~EOS).to_a # => ["foo", "#+BEGIN_SRC\n\nfoo\n\n#+END_SRC", "foo"]

data/examples/{element_alert.rb → type_alert.rb}

@@ -1,17 +1,18 @@
+#+hidden: true
 require "./setup"
 
 puts Source2MD::Element.new(<<~EOS).to_md
 #+alert: (foo)
 EOS
 # >> --------------------------------------------------------------------------------
-# >> Source2MD::Type::ElementAlert
-# >> 
+# >> Source2MD::Part::TypeAlert
+# >>
 # >> head:
 # >> {:alert=>"(foo)"}
-# >> 
+# >>
 # >> in:
-# >> 
-# >> 
+# >>
+# >>
 # >> out:
 # >> :::message alert
 # >> (foo)

data/examples/type_code_include.rb

@@ -0,0 +1,26 @@
+#+hidden: true
+require "./setup"
+
+puts Source2MD::Element.new(<<~EOS).to_md
+
+#+code_include: input.yml
+#+name:
+
+EOS
+# >> > -------------------------------------------------------------------------------- Source2MD::Formatter::TypeCodeInclude
+# >> > {"code_include"=>"input.yml", "name"=>""}
+# >> > ------------------------------------------------------------ in
+# >> > 
+# >> > 
+# >> > ------------------------------------------------------------ out
+# >> > ```yml:
+# >> > ---
+# >> > one:
+# >> >   foo: 1
+# >> > ```
+# >> > ------------------------------------------------------------
+# >> ```yml:
+# >> ---
+# >> one:
+# >>   foo: 1
+# >> ```

data/examples/{element_md_header.rb → type_hidden.rb}

@@ -1,3 +1,4 @@
+#+hidden: true
 require "./setup"
 
 puts Source2MD::Element.new(<<~EOS).to_md
@@ -6,7 +7,7 @@ puts Source2MD::Element.new(<<~EOS).to_md
 ---
 EOS
 # >> --------------------------------------------------------------------------------
-# >> Source2MD::Type::ElementMdHeader
+# >> Source2MD::Part::TypeHidden
 # >> 
 # >> head:
 # >> {}

data/examples/{element_md_title.rb → type_md_title.rb}

@@ -1,9 +1,10 @@
+#+hidden: true
 require "./setup"
 
 puts Source2MD::Element.new(<<~EOS).to_md
 ## foo ##
 EOS
-# >> > -------------------------------------------------------------------------------- Source2MD::Type::ElementMdTitle
+# >> > -------------------------------------------------------------------------------- Source2MD::Part::TypeMdTitle
 # >> > {}
 # >> > ------------------------------------------------------------ in
 # >> > ## foo ##

data/examples/{element_method.rb → type_method.rb}

@@ -1,3 +1,4 @@
+#+hidden: true
 require "./setup"
 
 puts Source2MD::Element.new(<<~EOS).to_md
@@ -9,7 +10,7 @@ code1
 code2
 EOS
 # >> --------------------------------------------------------------------------------
-# >> Source2MD::Type::ElementMethod
+# >> Source2MD::Part::TypeMethod
 # >> 
 # >> head:
 # >> {:name=>"(name)", :desc=>"(desc)", :comment=>"(comment)"}

data/examples/{element_partial_code.rb → type_partial_code.rb}

@@ -1,10 +1,11 @@
+#+hidden: true
 require "./setup"
 
 puts Source2MD::Element.new(<<~EOS).to_md
 (foo)
 EOS
 # >> --------------------------------------------------------------------------------
-# >> Source2MD::Type::ElementPartialCode
+# >> Source2MD::Part::TypePartialCode
 # >> 
 # >> head:
 # >> {}

data/examples/{element_deep_comment.rb → type_source_block.rb}

@@ -1,18 +1,19 @@
+#+hidden: true
 require "./setup"
 
 puts Source2MD::Element.new(<<~EOS).to_md
-## (foo)
+#+BEGIN_SRC diff xxx:yyy hidden!
+(foo)
+#+END_SRC
 EOS
-# >> > -------------------------------------------------------------------------------- Source2MD::Type::ElementPartialCode
+# >> > -------------------------------------------------------------------------------- Source2MD::Formatter::TypeSourceBlock
 # >> > {}
 # >> > ------------------------------------------------------------ in
-# >> > ## (foo)
+# >> > #+BEGIN_SRC diff xxx:yyy hidden!
+# >> > (foo)
+# >> > #+END_SRC
 # >> > 
 # >> > ------------------------------------------------------------ out
-# >> > ```ruby
-# >> > ## (foo)
-# >> > ```
+# >> > 
 # >> > ------------------------------------------------------------
-# >> ```ruby
-# >> ## (foo)
-# >> ```
+# >> 

data/examples/{element_table.rb → type_table.rb}

@@ -1,3 +1,4 @@
+#+hidden: true
 require "./setup"
 
 puts Source2MD::Element.new(<<~EOS).to_md

data/examples/type_text.rb

@@ -0,0 +1,24 @@
+#+hidden: true
+require "./setup"
+
+puts Source2MD::Element.new(<<~EOS).to_md
+#+oneline: true
+# a
+# b
+#
+# c
+# d
+EOS
+# >> > -------------------------------------------------------------------------------- Source2MD::Formatter::TypeText
+# >> > {"oneline"=>"true"}
+# >> > ------------------------------------------------------------ in
+# >> > # a
+# >> > # b
+# >> > #
+# >> > # c
+# >> > # d
+# >> > 
+# >> > ------------------------------------------------------------ out
+# >> > abcd
+# >> > ------------------------------------------------------------
+# >> abcd