jekyll-pseudocode-latex 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: edc827f76e4159ad63393e9c3cbbac8f9fac37847135d14855f68fd88c2e5e22
+  data.tar.gz: 759e33d237d4fbaa61c1f7a9b0b8b4a51092c66f323091dd129a81c5b8b8fd4b
+SHA512:
+  metadata.gz: 210fe9e506dfdba43c09769af31d5538b1f5d8f577ef2d45804484114b702bd62887a2f7eca11e0ebabc7aaa435aed2e8b3172bedd831a3219362e3bcaa41dd0
+  data.tar.gz: e87a088f37cda6c87d73bc53e41b7cf92a11cb916abac772fb7e27f4cb81f4318c88d4341b476930470120922469d9e133d104b65436b4cea33b7a4bf7ece907

data/README.md

@@ -0,0 +1,218 @@
+# Jekyll Pseudocode Plugin
+
+A Jekyll plugin to render pseudocode blocks using a simplified syntax similar to LaTeX.
+
+## Installation
+
+Add this line to your Jekyll site's `Gemfile`:
+
+```ruby
+gem "jekyll-pseudocode"
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+Or install it yourself as:
+
+```bash
+gem install jekyll-pseudocode
+```
+
+## Usage
+
+1. **Create a Pseudocode Block:**
+
+   Use the `pseudocode` tag in your Markdown files to create a pseudocode block. Here is an example:
+
+   ```markdown
+   ---
+   title: Quicksort Algorithm
+   ---
+
+   {% pseudocode %}
+   % This quicksort algorithm is extracted from Chapter 7, Introduction to Algorithms (3rd edition)
+   \begin{algorithm}
+   \caption{Quicksort}
+   \begin{algorithmic}
+   \PROCEDURE{Quicksort}{$A, p, r$}
+       \IF{$p < r$} 
+           \STATE $q = $ \CALL{Partition}{$A, p, r$}
+           \STATE \CALL{Quicksort}{$A, p, q - 1$}
+           \STATE \CALL{Quicksort}{$A, q + 1, r$}
+       \ENDIF
+   \ENDPROCEDURE
+   \PROCEDURE{Partition}{$A, p, r$}
+       \STATE $x = A[r]$
+       \STATE $i = p - 1$
+       \FOR{$j = p$ \TO $r - 1$}
+           \IF{$A[j] < x$}
+               \STATE $i = i + 1$
+               \STATE exchange $A[i]$ with $A[j]$
+           \ENDIF
+       \ENDFOR
+       \STATE exchange $A[i]$ with $A[r]$
+   \ENDPROCEDURE
+   \end{algorithmic}
+   \end{algorithm}
+   {% endpseudocode %}
+   ```
+
+2. **Copy the CSS File:**
+
+   Ensure you have the CSS file in `assets/css/pseudocode.css` with the following content. You can copy it from the plugin repository:
+
+   ```css
+   .ps-root {
+     font-family: MJXZERO, MJXTEX;
+     font-size: 1em;
+     font-weight: 100;
+     -webkit-font-smoothing: antialiased !important;
+   }
+
+   .ps-root .ps-algorithm {
+     margin: .8em 0;
+     border-top: 3px solid #000;
+     border-bottom: 2px solid #000;
+   }
+
+   .ps-root .ps-algorithm.with-caption {
+     border-bottom: 2px solid #000;
+   }
+
+   .ps-root .ps-indent-1 {
+     margin-left: 1em;
+   }
+
+   .ps-root .ps-indent-2 {
+     margin-left: 2em;
+   }
+
+   .ps-root .ps-indent-3 {
+     margin-left: 3em;
+   }
+
+   .ps-root .ps-indent-4 {
+     margin-left: 4em;
+   }
+
+   .ps-root .ps-indent-5 {
+     margin-left: 5em;
+   }
+
+   .ps-root .ps-caption {
+     display: block;
+     border-bottom: 2px solid #000;
+     margin-top: 4px !important;
+     margin-bottom: 0.5em;
+   }
+
+   .ps-root .MathJax, .ps-root .MathJax_CHTML {
+     text-indent: 0;
+     font-size: 1em !important;
+   }
+
+   .ps-root .ps-line {
+     margin: 0;
+     padding: 0;
+     line-height: 1.2;
+   }
+
+   .ps-root .ps-funcname {
+     font-family: MJXZERO, MJXTEX;
+     font-weight: 400;
+     font-style: normal;
+     text-transform: none;
+   }
+
+   .ps-root .ps-keyword {
+     font-family: MJXZERO, MJXTEX;
+     font-weight: 700;
+     font-style: normal;
+     text-transform: none;
+   }
+
+   .ps-root .ps-comment {
+     font-family: MJXZERO, MJXTEX;
+     font-weight: 400;
+     font-style: normal;
+     text-transform: none;
+   }
+
+   .ps-root .ps-linenum {
+     font-size: .8em;
+     line-height: 1em;
+     width: 1.6em;
+     text-align: right;
+     display: inline-block;
+     position: relative;
+     padding-right: .3em;
+   }
+
+   .ps-root .ps-algorithmic.with-linenum .ps-line.ps-code {
+     text-indent: -1.6em;
+   }
+
+   .ps-root .ps-algorithmic.with-linenum .ps-line.ps-code > span {
+     text-indent: 0;
+   }
+
+   .ps-root .ps-algorithmic.with-scopelines .ps-block {
+     border-left-style: solid;
+     border-left-width: .1em;
+     padding-left: .6em;
+   }
+
+   .ps-root .ps-algorithmic.with-scopelines > .ps-block {
+     border-left: none;
+   }
+   ```
+
+3. **Update `_config.yml`:**
+
+   Add the following line to your `_config.yml` file to include the CSS file:
+
+   ```yaml
+   site-css:
+     - "/assets/css/pseudocode.css"
+   ```
+
+4. **Include the CSS and MathJax in Your Pages or Layouts:**
+
+   Add the following lines to the HTML of your pages or layouts to include the CSS and MathJax:
+
+   ```html
+   <link rel="stylesheet" href="assets/css/pseudocode.css">
+   <script src="https://polyfill.io/v3/polyfill.min.js?features=es6"></script>
+   <script>
+   window.MathJax = {
+     tex: {
+       inlineMath: [['$', '$'], ['\\(', '\\)']]
+     },
+     svg: {
+       fontCache: 'global'
+     }
+   };
+
+   (function () {
+     var script = document.createElement('script');
+     script.src = 'https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-svg.js';
+     script.async = true;
+     document.head.appendChild(script);
+   })();
+   </script>
+   ```
+
+5. **Build and Serve Your Site:**
+
+   Rebuild and serve your Jekyll site to see the changes:
+
+   ```bash
+   bundle exec jekyll serve
+   ```
+
+By following these instructions, you'll be able to use the Jekyll pseudocode plugin in your site. If you encounter any issues, please refer to the plugin repository for additional troubleshooting and support.
+```

data/assets/css/pseudo-code.css

@@ -0,0 +1,104 @@
+.ps-root {
+font-family: MJXZERO, MJXTEX;
+font-size: 1em;
+font-weight: 100;
+-webkit-font-smoothing: antialiased !important;
+}
+
+.ps-root .ps-algorithm {
+margin: .8em 0;
+border-top: 3px solid #000;
+border-bottom: 2px solid #000;
+}
+
+.ps-root .ps-algorithm.with-caption {
+border-bottom: 2px solid #000;
+}
+
+.ps-root .ps-indent-1 {
+margin-left: 1em;
+}
+
+.ps-root .ps-indent-2 {
+margin-left: 2em;
+}
+
+.ps-root .ps-indent-3 {
+margin-left: 3em;
+}
+
+.ps-root .ps-indent-4 {
+margin-left: 4em;
+}
+
+.ps-root .ps-indent-5 {
+margin-left: 5em;
+}
+
+
+.ps-root .ps-caption {
+display: block;
+border-bottom: 2px solid #000;
+margin-top: 4px!important;
+margin-bottom: 0.5em;
+}
+
+.ps-root .MathJax, .ps-root .MathJax_CHTML {
+text-indent: 0;
+font-size: 1em !important;
+}
+
+.ps-root .ps-line {
+margin: 0;
+padding: 0;
+line-height: 1.2;
+}
+
+.ps-root .ps-funcname {
+font-family: MJXZERO, MJXTEX;
+font-weight: 400;
+font-style: normal;
+text-transform: none;
+}
+
+.ps-root .ps-keyword {
+font-family: MJXZERO, MJXTEX;
+font-weight: 700;
+font-style: normal;
+text-transform: none;
+}
+
+.ps-root .ps-comment {
+font-family: MJXZERO, MJXTEX;
+font-weight: 400;
+font-style: normal;
+text-transform: none;
+}
+
+.ps-root .ps-linenum {
+font-size: .8em;
+line-height: 1em;
+width: 1.6em;
+text-align: right;
+display: inline-block;
+position: relative;
+padding-right: .3em;
+}
+
+.ps-root .ps-algorithmic.with-linenum .ps-line.ps-code {
+text-indent: -1.6em;
+}
+
+.ps-root .ps-algorithmic.with-linenum .ps-line.ps-code > span {
+text-indent: 0;
+}
+
+.ps-root .ps-algorithmic.with-scopelines .ps-block {
+border-left-style: solid;
+border-left-width: .1em;
+padding-left: .6em;
+}
+
+.ps-root .ps-algorithmic.with-scopelines > .ps-block {
+border-left: none;
+}

data/lib/jekyll/pseudocode.rb

@@ -0,0 +1,181 @@
+require 'jekyll'
+require 'liquid'
+require 'rexml/document'
+
+module Jekyll
+  class PseudocodeBlock < Liquid::Block
+    @@number = 0
+
+    def initialize(tag_name, text, tokens)
+      super
+    end
+
+    def render(context)
+      content = super
+      @@number += 1
+      content = process_pseudocode(content)
+      "<div class='ps-root'>#{content}</div>"
+    end
+
+    def process_pseudocode(content)
+      open_divs = []
+      indent_level = 0
+      content_lines = content.strip.split("\n")
+      html_lines = []
+
+      call_pattern = /\\CALL\{(.*?)\}\{(.*?)\}/
+
+      replace_calls = lambda do |statement|
+        statement.gsub(call_pattern) { |match| "<span class='ps-call'><span class='ps-funcname'>#{Regexp.last_match(1)}</span>(#{Regexp.last_match(2)})</span>" }
+      end
+
+      wrap_math_expressions = lambda do |statement|
+        statement.gsub(/\$(.*?)\$/, '<span class="arithmatex">\\(\1\\)</span>')
+      end
+
+      process_control_statement = lambda do |keyword, condition|
+        condition = wrap_math_expressions.call(condition)
+        additional_keyword = keyword == "if" ? "then" : "do"
+        if keyword == "for"
+          condition = condition.gsub(/\\TO/, '<span class="ps-keyword">to</span>')
+        end
+        "<div class='ps-#{keyword.downcase} ps-indent-#{indent_level}'><span class='ps-keyword'>#{keyword.downcase}</span> (#{condition}) <span class='ps-keyword'>#{additional_keyword}</span>"
+      end
+
+      content_lines.each do |line|
+        stripped_line = line.strip
+
+        case stripped_line
+        when /\\begin{algorithm}/
+          html_lines << "<div class='ps-algorithm'>"
+          open_divs << 'algorithm'
+        when /\\end{algorithm}/
+          if open_divs.last == 'algorithm'
+            html_lines << "</div>"
+            open_divs.pop
+          end
+        when /\\caption{(.*?)}/
+          caption = stripped_line.match(/\\caption{(.*?)}/)[1]
+          html_lines[-1] = "<div class='ps-algorithm with-caption'><div class='ps-caption'><span class='ps-keyword'>Algorithm #{@@number}</span> #{caption}</div>"
+        when /\\begin{algorithmic}/
+          html_lines << "<div class='ps-algorithmic'>"
+          open_divs << 'algorithmic'
+        when /\\end{algorithmic}/
+          if open_divs.last == 'algorithmic'
+            html_lines << "</div>"
+            open_divs.pop
+          end
+        when /\\PROCEDURE{(.*?)}{(.*?)}/
+          procedure_name = stripped_line.match(/\\PROCEDURE{(.*?)}{(.*?)}/)[1]
+          params = stripped_line.match(/\\PROCEDURE{(.*?)}{(.*?)}/)[2]
+          params = wrap_math_expressions.call(params)
+          html_lines << "<div class='ps-procedure ps-indent-#{indent_level}'><span class='ps-keyword'>procedure </span><span class='ps-funcname'>#{procedure_name}</span>(#{params})"
+          open_divs << 'procedure'
+          indent_level += 1
+        when /\\ENDPROCEDURE/
+          if open_divs.last == 'procedure'
+            indent_level -= 1
+            html_lines << "<div class='ps-keyword'>end procedure</div></div>"
+            open_divs.pop
+          end
+        when /\\IF{(.*?)}/
+          condition = stripped_line.match(/\\IF{(.*?)}/)[1]
+          statement = process_control_statement.call('if', condition)
+          html_lines << statement
+          open_divs << 'if'
+          indent_level += 1
+        when /\\ENDIF/
+          if open_divs.last == 'if'
+            indent_level -= 1
+            html_lines << "<div class='ps-keyword'>end if</div></div>"
+            open_divs.pop
+          end
+        when /\\FOR{(.*?)}/
+          loop = stripped_line.match(/\\FOR{(.*?)}/)[1]
+          statement = process_control_statement.call('for', loop)
+          html_lines << statement
+          open_divs << 'for'
+          indent_level += 1
+        when /\\ENDFOR/
+          if open_divs.last == 'for'
+            indent_level -= 1
+            html_lines << "<div class='ps-keyword'>end for</div></div>"
+            open_divs.pop
+          end
+        when /\\FOREACH{(.*?)}/
+          loop = stripped_line.match(/\\FOREACH{(.*?)}/)[1]
+          statement = "<div class='ps-foreach ps-indent-#{indent_level}'><span class='ps-keyword'>for each</span> (#{wrap_math_expressions.call(loop)}) <span class='ps-keyword'>do</span>"
+          html_lines << statement
+          open_divs << 'foreach'
+          indent_level += 1
+        when /\\ENDFOREACH/
+          if open_divs.last == 'foreach'
+            indent_level -= 1
+            html_lines << "<div class='ps-keyword'>end for each</div></div>"
+            open_divs.pop
+          end
+        when /\\WHILE{(.*?)}/
+          condition = stripped_line.match(/\\WHILE{(.*?)}/)[1]
+          statement = process_control_statement.call('while', condition)
+          html_lines << statement
+          open_divs << 'while'
+          indent_level += 1
+        when /\\ENDWHILE/
+          if open_divs.last == 'while'
+            indent_level -= 1
+            html_lines << "<div class='ps-keyword'>end while</div></div>"
+            open_divs.pop
+          end
+        when /\\REPEAT{(.*?)}/
+          condition = stripped_line.match(/\\REPEAT{(.*?)}/)[1]
+          statement = process_control_statement.call('repeat', condition)
+          html_lines << statement
+          open_divs << 'repeat'
+          indent_level += 1
+        when /\\ENDREPEAT/
+          if open_divs.last == 'repeat'
+            indent_level -= 1
+            html_lines << "<div class='ps-keyword'>end repeat</div></div>"
+            open_divs.pop
+          end
+        when /\\ELSEIF{(.*?)}/
+          condition = stripped_line.match(/\\ELSEIF{(.*?)}/)[1]
+          statement = process_control_statement.call('elseif', condition)
+          html_lines << statement
+          if open_divs.last == 'if'
+            open_divs.pop
+            open_divs << 'elseif'
+          end
+        when /\\ELSE/
+          html_lines << "<div class='ps-else ps-indent-#{indent_level}'><span class='ps-keyword'>else</span>"
+          if open_divs.last == 'if' || open_divs.last == 'elseif'
+            open_divs.pop
+            open_divs << 'else'
+          end
+        when /\\STATE{(.*?)}/
+          statement = stripped_line.match(/\\STATE{(.*?)}/)[1]
+          statement = replace_calls.call(statement)
+          statement = wrap_math_expressions.call(statement)
+          html_lines << "<div class='ps-state ps-indent-#{indent_level}'>#{statement}</div>"
+        when /\\STATE\s+(.*)/
+          statement = stripped_line.match(/\\STATE\s+(.*)/)[1]
+          statement = replace_calls.call(statement)
+          statement = wrap_math_expressions.call(statement)
+          html_lines << "<div class='ps-state ps-indent-#{indent_level}'>#{statement}</div>"
+        when /\\CALL{(.*?)}{(.*?)}/
+          call = stripped_line.match(/\\CALL{(.*?)}{(.*?)}/)[1]
+          params = stripped_line.match(/\\CALL{(.*?)}{(.*?)}/)[2]
+          html_lines << "<div class='ps-call ps-indent-#{indent_level}'><span class='ps-funcname'>#{call}</span>(#{params})</div>"
+        else
+          html_lines << "<div class='ps-line ps-indent-#{indent_level}'>#{replace_calls.call(wrap_math_expressions.call(stripped_line))}</div>"
+        end
+      end
+
+      open_divs.reverse_each { |div| html_lines << "</div>" }
+
+      html_lines.join("\n")
+    end
+  end
+end
+
+Liquid::Template.register_tag('pseudocode', Jekyll::PseudocodeBlock)

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-pseudocode-latex
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jules Topart
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-06-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: This plugin allows you to write pseudocode blocks in your Jekyll site
+  using a simplified syntax similar to LaTeX. Make sure to include MathJax
+email:
+- jules.topart@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- assets/css/pseudo-code.css
+- lib/jekyll/pseudocode.rb
+homepage: https://github.com/JulesTopart/jekyll-pseudocode-latex
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.11
+signing_key:
+specification_version: 4
+summary: A Jekyll plugin to render pseudocode blocks using latex format from MathJax.
+test_files: []