markita 4.1.230214 → 6.0.250327

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3f0f724a5032aef309176a00528c84199b06fc0a6f9f8fa9b36b0ad81077adca
-  data.tar.gz: 371e1025357b9686e31697f563ba6534e2706df21bb2ce1e0586ea818467f387
+  metadata.gz: 9ed48aca2238e0b8ac390519ddc7d4c0e8e5e6f798b87a7654da9454f5f92cd3
+  data.tar.gz: bfec77d804b3e803c282e4581c6ac7008a716ad0c2d91c2e9dca170b9ecb987a
 SHA512:
-  metadata.gz: 59e8791389f0bc45488a9e80d6dc8cbd84abe8eb663550e46aff32d1ee8c32f0d0ea60e3dee4be57f589672aa4c23e7e41a305ac491141d2df955cb0aa230e88
-  data.tar.gz: 64ab90255ad7ab0ba1dcce4824bd33b5585e4ecf61333ad5bdabf75f9650eb625131fd79efb7b0968e7d99ab6c3c5eeff978e832eb7c2ce4fe95b6bb3c4202a1
+  metadata.gz: 4feb3c5ba26177dc86f27ab90599c120a3d0631f24d5919d28efacb39edd7bbdb5d6a76d9eb28ee852ec0b0bfdfc41ea3097b82f1bdc29d533686f95756bb13f
+  data.tar.gz: b8dfe46d0853061fe8d7d8a666e1c102b249a12cd3ad26558b05ebe5893d899b03add66fe8d9da41fd984e27e7d158cb0b69d1967e7fe365f703c2e2ba74ae20

data/README.md

@@ -1,6 +1,6 @@
 # Markita
 
-* [VERSION 4.1.230214](https://github.com/carlosjhr64/markita/releases)
+* [VERSION 6.0.250327](https://github.com/carlosjhr64/markita/releases)
 * [github](https://www.github.com/carlosjhr64/markita)
 * [rubygems](https://rubygems.org/gems/markita)
 
@@ -25,221 +25,78 @@ Options:
   --port=PORT      	 8080
   --theme=THEME    	 base16.light
   --allowed=IPS
-  --no_about
-  --no_favicon
-  --no_highlight
-  --no_login
-  --no_navigation
-  --no_plugs
-  --no_readme
-Exclusive:
-  no_login allowed
+  --no=PLUGS
 Types:
   DIRECTORY /^~?[\/\w\.]+$/
   BIND      /^[\w\.]+$/
   PORT      /^\d+$/
   IPS       /^[\d\.\,]+$/
   THEME     /^[\w\.]+$/
+  PLUGS    /^[\w\,]+$/
 # NOTE:
 # Assuming site is in ~/vimwiki,
 # when ~/vimwiki/.valid-id is set with a sha256sum of a password,
 # that password will restrict the site.
 # Allowed IPs bypass the need for site password
 # when the site is accessed from those locations.
+# You can use the --no option to list plugins to disable.
 ```
 ## FEATURES
 
-### Ballot boxes
+* `#` Headers with link anchors
+* `>` Block-quotes nests up to level three
+* ``` Code section highlighted by [Rouge](https://github.com/rouge-ruby/rouge)
+* PRE-forms on text starting with four spaces
+* Tables
+* Script section pass through starts with `^<script` and ends with `^</script>`
+* HTML pass through on `/^<.*>$/` lines
+* And more...
 
-- [ ] Empty ballot
-- [x] Marked ballot
-
-Markdown:
-
-    - [ ] Empty ballot
-    - [x] Marked ballot
-
-### Image placement
-
-Markdown:
-
-    ![:Centered Image:](/img/image.png)
-    ![Left Floating:](/img/image.png)
-    ![:Right Floating](/img/image.png)
-    Image  centered above.
-    Image to the left.
-    Image to the right.
-    And set a HR bar below.
-    ---
-
-### Image size
-
-Markdown:
-
-    ![In alt text say 100x100](/img/image.png)
-
-### Image link
-
-Markdown:
-
-    ![Alt text](/img/image.png /href_to/page)
-
-### Forms
-
-Markdown:
-
-    A get method form without submit button on single field:
-    ! Google:[q] (https://www.google.com/search)
-
-    A post method form with a password field
-    and a submit button due to multiple fields.
-    Note the `*` in front of `pwd` marking it as a password field,
-    and the ending `!` marking the route as a post:
-    ! Username:[user] Password:[*pwd] (/login.html)!
-
-    A multi-line form with default entry and hidden field:
-    ! Name:[user] [status="active"] (/register.html)
-    ! Address:[address]
-    ! Code:[code="1234"]
-
-    A selection list:
-    ! Color:[color="Red","White","Blue"]
-
-### Template substitutions
-
-Markdown:
-
-    ! template = "* [&query;](https://www.google.com/search?q=&QUERY;)"
-    ! regx = /^\* (?<query>.*)$/
-    * Grumpy Cat
-    * It's over 9000!
-
-Template clears after first non-match.
-Note: on upcased keys, value is CGI escaped.
-
-### Split table
-
-<table><tr><td>
-<p>
-Top left
-</p>
-</td><td>
-<p>
-Top center
-</p>
-</td><td>
-<p>
-Top right
-</p>
-</td></tr><tr><td>
-<p>
-Middle left
-</p>
-</td><td>
-<p>
-Middle center
-</p>
-</td><td>
-<p>
-Middle left
-</p>
-</td></tr><tr><td>
-<p>
-Bottom left
-</p>
-</td><td>
-<p>
-Bottom center
-</p>
-</td><td>
-<p>
-Bottom right
-</p>
-</td></tr></table>
-
-Markdown:
-
-    |:
-    Top left
-    |
-    Top center
-    |
-    Top right
-    :|:
-    Middle left
-    |
-    Middle center
-    |
-    Middle left
-    :|:
-    Bottom left
-    |
-    Bottom center
-    |
-    Bottom right
-    :|
-
-### Inline links, code, bold, italic, strikes, and underline
-
-<p>
-The <b>bold</b> and <i>italics</i> <s>strikes</s> at <u>underlined</u>, while a
-<a href="#Markita">link to #Markita</a>
-sees the <code>~ code ~ "a*b*c"</code> to
-<a href="https://github.com">https://github.com</a>.
-</p>
-
-Markdown:
-
-    The *bold* and "italics" ~strikes~ at _underlined_,
-    while a [link to #Markita](#Markita)
-    sees the `~ code ~ "a*b*c"` to [https://github.com].
+### Meta-data
 
-### Lists: ordered, un-ordered, definitions
+* `$key` substitution to its metadata value in text
+* If `Title` is set via meta-data, Javascript will set the page's title to that
+* One can use numbers to reference long URLs
+```markdown
+--- # The hashtag disambiguates the horizontal rule(legal YAML comment).
+Title: Markita
+1: https://github.com/carlosjhr64/markita
+name: Don Quixote de la Mancha
+# You can also add to attributes here:
+attributes: style="color: darkgreen;"
+... # The end marker is needed to end the fold
+[Markita](1)
+Your name is $name.
+```
+### Horizontal rule
+```markdown
+---
+```
+### Attributes
+```markdown
+{: style="color: blue;"}
+You can set the attributes for most blocks.
+```
+### Lists
 
+One can nest lists up to 3 levels:
+```markdown
+{: style="color: red;"}{: style="color: green;"}{: style="color: blue;"}
 1. One
 2. Two
-
-* Point A
-* Point B
-
-<dl>
-<dt>Word</dt>
-<dd>Definition of the word</dd>
-<dt>Symbol</dt>
-<dd>Usage for the symbol</dd>
-</dl>
-
-Markdown:
-
-    1. One
-    2. Two
-
-    * Point A
-    * Point B
-
-    + Word: Definition of the word
-    + Symbol:
-    +   Usage for the symbol
-
-### Block-quote
-
-Like Hamlet says...
-> To be or not to be...
-> That is the question!
-
-Markdown:
-
-    Like Hamlet says...
-    > To be or not to be...
-    > That is the question!
-
-### Code
-```ruby
-def wut
-  puts "Wut?"
-end
+ * ABC
+  - [ ] Empty ballot
+  - [x] Marked ballot
+ * XYZ
+3. Three
+```
+### Definitions
+```markdown
++ Word: Definition
++ Slang:
++ Define slang
 ```
-Markdown:
+### Code
 
     ```ruby
     def wut
@@ -253,62 +110,162 @@ Markdown:
 | ------: | ----: | :----: | :------------ |
 |       1 |   1.0 |   $    | The word      |
 |    1234 |  12.3 |   &    | On the street |
+```markdown
+| Integer | Float | Symbol | Word          |
+| ------: | ----: | :----: | :------------ |
+|       1 |   1.0 |   $    | The word      |
+|    1234 |  12.3 |   &    | On the street |
+```
+### Splits table
 
-Markdown:
-
-    | Integer | Float | Symbol | Word          |
-    | ------: | ----: | :----: | :------------ |
-    |       1 |   1.0 |   $    | The word      |
-    |    1234 |  12.3 |   &    | On the street |
-
-### Attributes
-
-Markdown:
-
-    {: style="color: blue;"}
-    You can set the attributes for most blocks.
+<table><tr><td>
+<p> Top left </p>
+</td><td>
+<p> Top center </p>
+</td><td>
+<p> Top right </p>
+</td></tr><tr><td>
+<p> Middle left </p>
+</td><td>
+<p> Middle center </p>
+</td><td>
+<p> Middle left </p>
+</td></tr><tr><td>
+<p> Bottom left </p>
+</td><td>
+<p> Bottom center </p>
+</td><td>
+<p> Bottom right </p>
+</td></tr></table>
 
+```markdown
+|:
+Top left
+|
+Top center
+|
+Top right
+:|:
+Middle left
+|
+Middle center
+|
+Middle left
+:|:
+Bottom left
+|
+Bottom center
+|
+Bottom right
+:|
+```
+### Image placement
+```markdown
+![:Centered Image:](/img/image.png)
+![Left Floating:](/img/image.png)
+![:Right Floating](/img/image.png)
+Image  centered above.
+Image to the left.
+Image to the right.
+```
+### Image size
+```markdown
+![In alt text say 100x100](/img/image.png)
+```
+### Image link
+```markdown
+![Alt text](/img/image.png /href_to/page)
+```
 ### Embed text
-
-Markdown:
-
-    !> /path-to/ascii_art.txt
-
+```markdown
+!> /path-to/ascii_art.txt
+```
 Useful for ASCII art.
 Unless an `*.html` file, the text is embedded in `pre` tags.
 Further more unless a `*.txt` file, the text is embedded in `code` tags.
 
-### Emojis
-
-I :heart: to :laughing:!
-
-Markdown:
+### Footnotes
+```markdown
+There once was a man from Nantucket[^1]  
+Who kept all his cash[^2] in a bucket.  
+But his daughter, named Nan,  
+Ran away with a man  
+And as for the bucket, Natucket.[^3]
+
+[^1]: Nantucket is an island in the U.S. state of Massachusetts.
+[^2]: Cash is money in currency.
+[^3]: Read as "Nan took it."
+```
+### Forms
+```markdown
+A get method form without submit button on single field:
+! Google:[q] (https://www.google.com/search)
+
+A post method form with a password field
+and a submit button due to multiple fields.
+Note the `*` in front of `pwd` marking it as a password field,
+and the ending `!` marking the route as a post:
+! Username:[user] Password:[*pwd] (/login.html)!
+
+A multi-line form with default entry and hidden field:
+! Name:[user] [status="active"] (/register.html)
+! Address:[address]
+! Code:[code="1234"]
+
+A selection list:
+! Color:[color="Red","White","Blue"]
+
+A submit button:
+! [submit="Go!"]
+```
+### Template substitutions
+```markdown
+! regx = /^This (?<word>\w+)/
+This cat is a pussy&word;.
+
+! template = "* [&query;](https://www.google.com/search?q=&QUERY;)"
+! regx = /^\* (?<query>.*)$/
+* Grumpy Cat
+* It's over 9000!
+```
+Template clears after first non-match.
+Note: on upcased keys, value is CGI escaped.
 
-    I :heart: to :laughing:!
+### Inline links, code, bold, italic, strikes, and underline
 
-### Footnotes
+The <b>bold</b> and <i>italics</i> <s>strikes</s> at <u>underlined</u>,
+while a [link to #Markita](#Markita)
+sees the `~ code ~ "a*b*c"` to https://github.com.
+```markdown
+The *bold* and "italics" ~strikes~ at _underlined_,
+while a [link to #Markita](#Markita)
+sees the `~ code ~ "a*b*c"` to https://github.com.
+```
+The inline links with optional title have the following syntax(with no double quotes):
+```markdown
+[link text](link title)
+```
+### Entity escapes
 
-Markdown:
+When you want to escape the inline substitutions or HTML tags, use backslash:
 
-    There once was a man from Nantucket[^1]  
-    Who kept all his cash[^2] in a bucket.  
-    But his daughter, named Nan,  
-    Ran away with a man  
-    And as for the bucket, Natucket.[^3]
+* &#92;&#60; &#92;&#62;  &#92;&#42; &#92;&#34; &#92;&#126; &#92;&#96; &#92;&#38; &#92;&#59; &#92;&#92;
 
-    [^1]: Nantucket is an island in the U.S. state of Massachusetts.
-    [^2]: Cash is money in currency.
-    [^3]: Read as "Nan took it."
+### Emojis
 
-### Meta-data
+I :heart: to :laughing:!
+```markdown
+I :heart: to :laughing:!
+```
+### Superscript and subscript
 
-Markdown:
+This is <sup>superscript</sup> and this is <sub>subscript</sub>.
+```markdown
+This is \^(superscript) and this is \(subscript).
+```
+### It's all Ruby!
 
-    ---
-    Title: The Title You Want For Your Page
-    1: https://way.to/create/ref/links
-    ---
-    You can now [link](1) with a reference number.
+Add your own custom features.
 
 ## HOW-TOs
 
@@ -351,7 +308,7 @@ $ GET https://raw.githubusercontent.com/carlosjhr64/markita/main/plug/todotxt.rb
 ```
 ## LICENSE
 
-Copyright (c) 2023 CarlosJHR64
+Copyright (c) 2025 CarlosJHR64
 
 Permission is hereby granted, free of charge,
 to any person obtaining a copy of this software and

data/bin/markita

@@ -1,4 +1,6 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
+
 require 'help_parser'
 require 'markita'
 
@@ -11,38 +13,33 @@ OPTIONS = HelpParser[Markita::VERSION, <<~HELP]
     --port=PORT      \t 8080
     --theme=THEME    \t base16.light
     --allowed=IPS
-    --no_about
-    --no_favicon
-    --no_highlight
-    --no_login
-    --no_navigation
-    --no_plugs
-    --no_readme
-  Exclusive:
-    no_login allowed
+    --no=PLUGS
   Types:
     DIRECTORY /^~?[\\/\\w\\.]+$/
     BIND      /^[\\w\\.]+$/
     PORT      /^\\d+$/
     IPS       /^[\\d\\.\\,]+$/
     THEME     /^[\\w\\.]+$/
+    PLUGS    /^[\\w\\,]+$/
   # NOTE:
   # Assuming site is in ~/vimwiki,
   # when ~/vimwiki/.valid-id is set with a sha256sum of a password,
   # that password will restrict the site.
   # Allowed IPs bypass the need for site password
   # when the site is accessed from those locations.
+  # You can use the --no option to list plugins to disable.
 HELP
 begin
+  Markita.no.concat OPTIONS.no.split(',').map(&:to_sym) if OPTIONS.no?
   Markita.run!
-rescue LoadError
-  HelpParser::REDTTY["#{$!.class}: #{$!.message}"]
-  exit 72
-rescue RuntimeError
-  HelpParser::REDTTY["#{$!.class}: #{$!.message}"]
-  exit 65
-rescue
-  warn $!.backtrace
-  HelpParser::REDTTY["#{$!.class}: #{$!.message}"]
-  exit 70
+rescue LoadError => e
+  HelpParser::REDTTY["#{e.class}: #{e.message}"]
+  exit 72 # EX_OSFILE
+rescue RuntimeError => e
+  HelpParser::REDTTY["#{e.class}: #{e.message}"]
+  exit 65 # EX_DATAERR: generic runtime error raised, usually due to user error.
+rescue StandardError => e
+  warn e.backtrace
+  HelpParser::REDTTY["#{e.class}: #{e.message}"]
+  exit 70 # EX_SOFTWARE
 end

data/lib/markita/base.rb

@@ -1,48 +1,47 @@
+# frozen_string_literal: true
+
+# Markita namespace
 module Markita
-class Base < Sinatra::Base
-  set bind: OPTIONS&.bind || '0.0.0.0'
-  set port: OPTIONS&.port || '8080'
-  set sessions: true
+  # Base class of the Sinatra Markita application
+  class Base < Sinatra::Base
+    set sessions: true
+    set bind: BIND
+    set port: PORT
+    set server: SERVER
+    set server_settings: SERVER_SETTINGS if SERVER_SETTINGS
 
-  def self.run!
-    puts "#{$0}-#{VERSION}"
-    super do |server|
-      if ['.cert.crt', '.pkey.pem'].all?{ File.exist? File.join(ROOT, _1)}
-        server.ssl = true
-        server.ssl_options = {
-          :cert_chain_file  => File.join(ROOT, '.cert.crt'),
-          :private_key_file => File.join(ROOT, '.pkey.pem'),
-          :verify_peer      => false,
-        }
-      end
+    def self.run!
+      super { SERVER_CONFIG[it] }
     end
-  end
 
-  get PAGE_KEY do |key|
-    filepath = File.join ROOT, key+'.md'
-    raise Sinatra::NotFound unless File.exist? filepath
-    Markdown.new(key).filepath filepath
-  end
+    get PAGE_KEY do |key|
+      filepath = File.join ROOT, key + MDX
+      raise Sinatra::NotFound unless File.exist? filepath
 
-  get SEND_FILE do |path|
-    pass unless params.length==1 &&
-                (filepath=File.join ROOT, path) &&
-                File.exist?(filepath)
-    send_file filepath
-  end
+      Markdown.new(key).filepath filepath
+    end
 
-  get '/' do
-    filepath = File.join ROOT, 'index.md'
-    if File.exist? filepath
-      Markdown.new('index').filepath filepath
-    else
-      redirect '/about.html' unless OPTIONS&.no_about
-      raise Sinatra::NotFound
+    # For the server to send a static file, the request may only specify a path
+    # (no query string) and the file must exist... Else, it passes.
+    get SEND_FILE do |path|
+      pass unless params.length == 1 &&
+                  (filepath = File.join ROOT, path) &&
+                  File.exist?(filepath)
+      send_file filepath
+    end
+
+    get '/' do
+      filepath = File.join ROOT, INDEX + MDX
+      if File.exist? filepath
+        Markdown.new(INDEX).filepath filepath
+      else
+        redirect '/about.html' unless Markita.no.include? :about
+        raise Sinatra::NotFound
+      end
     end
-  end
 
-  not_found do
-    NOT_FOUND
+    not_found do
+      NOT_FOUND
+    end
   end
 end
-end