wikitxt 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4e5704039755967692a650315743227791fe25a36ebf8992d49e16acb18d657a
-  data.tar.gz: 6565361a2408ec0bf3dd4145d35bd3a0c3d581446e53b762d254f45e379836a0
+  metadata.gz: d3b04ad6ac8b66425ee7374b81ca20cdcb39611ff5a57751eae0f3a54a5937fb
+  data.tar.gz: a3f1748ed210269426e8f3a9256fd3b22574427d7f26983c437d773298e9a722
 SHA512:
-  metadata.gz: 1c3e4196d18406cc4a3baaef4270d6e76edadc3cb6c689f1fc9253689910fb2bd0a5c05d890dd72f37e2f5cdc65a2419eb9ca4d5f6301850db142dfef7780827
-  data.tar.gz: 26bbccbfcda9ca87ea9210a3ca52c63427db8722873f0a8de837b1a9d7dc83424f0335bcf70968073112a6ea7cc4d8a91e1bf176e65a734a0f1e54102cc120a8
+  metadata.gz: a56d2d48bf432221678bfe940d784526d5957593c2ce9712777d10872d0fd5ea814a096aba8efd946501757f88d5131dd4e7acd46c871ef02fcae97e69d4bbc0
+  data.tar.gz: '0383569f43fa4ea1e8d80fb079c62b1deb49c287d2df5afcac193aa3b8a5d96fc19319bd47030111949743d89d2e3cecbf4a61ee4d6fd70f888eb5f5c79fe763'

data/CHANGELOG.md

@@ -3,3 +3,11 @@
 ## [0.1.0] - 2024-04-12
 
 - Initial release
+
+## [0.1.1] - 2024-04-12
+
+- Add styles and layout
+
+## [0.1.2] - 2024-04-12
+
+- Fix link node and test

data/Gemfile.lock

@@ -1,15 +1,13 @@
 PATH
   remote: .
   specs:
-    wikitxt (0.1.0)
-      sinatra (~> 4.0)
+    wikitxt (0.1.2)
       thor (~> 1.3)
       webrick (~> 1.8)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    base64 (0.2.0)
     coderay (1.1.3)
     diff-lcs (1.5.1)
     ffi (1.16.3)
@@ -32,8 +30,6 @@ GEM
       rb-inotify (~> 0.9, >= 0.9.10)
     lumberjack (1.2.10)
     method_source (1.0.0)
-    mustermann (3.0.0)
-      ruby2_keywords (~> 0.0.1)
     nenv (0.3.0)
     notiffany (0.1.3)
       nenv (~> 0.1)
@@ -41,12 +37,6 @@ GEM
     pry (0.14.2)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    rack (3.0.10)
-    rack-protection (4.0.0)
-      base64 (>= 0.1.0)
-      rack (>= 3.0.0, < 4)
-    rack-session (2.0.0)
-      rack (>= 3.0.0)
     rake (13.2.1)
     rb-fsevent (0.11.2)
     rb-inotify (0.10.1)
@@ -64,18 +54,10 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
     rspec-support (3.13.1)
-    ruby2_keywords (0.0.5)
     shellany (0.0.1)
-    sinatra (4.0.0)
-      mustermann (~> 3.0)
-      rack (>= 3.0.0, < 4)
-      rack-protection (= 4.0.0)
-      rack-session (>= 2.0.0, < 3)
-      tilt (~> 2.0)
     spoon (0.0.6)
       ffi
     thor (1.3.1)
-    tilt (2.3.0)
     webrick (1.8.1)
 
 PLATFORMS

data/Guardfile

@@ -1,4 +1,4 @@
 guard :process, name: 's', command: "exe/wikitxt s samples" do
-  watch('lib/html/layout.html.erb')
-  watch('lib/wikitxt/cli')
+  watch(%r{lib/.+$})
+  watch(%r{samples/.+$})
 end

data/README.md

@@ -1,6 +1,12 @@
-# Wikitxt
+# Wiki.txt
 
-Most lightweight wiki written by plain text.
+![v](https://badgen.net/rubygems/v/wikitxt)
+![dt](https://badgen.net/rubygems/dt/wikitxt)
+![license](https://badgen.net/github/license/kawakamimoeki/wikitxt)
+
+Most lightweight markup language and personal knowledge manager or wiki platform.
+
+![screenshot](https://github.com/kawakamimoeki/wikitxt/blob/main/docs/screenshot.png)
 
 ## Installation
 
@@ -12,8 +18,61 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
     $ gem install wikitxt
 
+## Syntax
+
+Paragraphs:
+
+```
+Wikitxt is a lightweight markup language and a tool for composing Wiki . The syntax of Wikitxt can be converted to HTML and viewed in a browser. When converted to HTML, files can be interlinked.
+```
+
+Lists:
+
+```
+  Lists
+    Based on the idea that most information can be expressed in lists
+  Paragraphs
+    Paragraphs always have the potential to be listed. They can easily be converted to lists.
+    Paragraphs can also serve as headings.
+  Mutual Links
+    Text decoration is limited to links.
+    Words you want to emphasize should be expressed as wiki pages.
+```
+
+Internal Links:
+
+```
+#internallink
+```
+
+Internal Images:
+
+```
+#internalimage.png
+```
+
+External Links:
+
+```
+#<https://example.com Example Domain>
+```
+
+External Images:
+
+```
+#<https://example.com/image.png Example Image>
+```
+
 ## Usage
 
+### Render HTML
+
+```ruby
+Wikitxt.to_html(text)
+```
+
+### Server
+
 `wiki/index.txt`:
 
 ```
@@ -42,7 +101,7 @@ Cras at tortor urna. Maecenas nec iaculis nulla.
 ```
 
 ```
-wikitxt s
+$ wikitxt s
 ```
 
 Access to http://localhost:8000 .

data/lib/html/layout.html.erb

@@ -35,11 +35,15 @@
     background: #333;
     border-radius: 100%;
   }
+
+  img {
+    max-width: 100%;
+  }
 </style>
 
 <body>
   <div class="content">
-    <div class="title"><%= title %></div>
+    <div class="title"><%= title.capitalize %></div>
     <%= body %>
   </div>
 </body>

data/lib/wikitxt/cli.rb

@@ -1,6 +1,7 @@
 require "thor"
 require 'webrick'
 require 'erb'
+require 'fileutils'
 
 module Wikitxt
   class CLI < Thor
@@ -18,6 +19,8 @@ module Wikitxt
         Dir.mkdir("dist") unless Dir.exist?("dist")
         File.write(File.join("dist", "#{title}.html"), html)
       end
+      images = Dir.glob(File.join(path, "*.{png,jpg,jpeg}"))
+      FileUtils.cp(images, "dist")
       server = WEBrick::HTTPServer.new :Port => 8000, :DocumentRoot => "dist"
       trap 'INT' do server.shutdown end
       server.start

data/lib/wikitxt/node.rb

@@ -45,7 +45,13 @@ module Wikitxt
 
   class LinkNode < BaseNode
     def to_html
-      " <a href=\"/#{attrs[:page]}.html\">#{attrs[:page]}</a> "
+      " <a href=\"#{attrs[:url]}\">#{attrs[:title]}</a> "
+    end
+  end
+
+  class ImageNode < BaseNode
+    def to_html
+      "<img src=\"#{attrs[:url]}\" title=\"#{attrs[:title]}\" />"
     end
   end
 end

data/lib/wikitxt/parser.rb

@@ -37,17 +37,28 @@ module Wikitxt
 
         scanner = StringScanner.new(parent.attrs[:text])
 
-        if match = parent.attrs[:text].match(/^#(?<page>.+)$/)
-          parent.children << LinkNode.new(page: match[:page])
-          return parent.children.map(&:to_html).join
-        end
-
         until scanner.eos? do
-          if result = scanner.scan(/ #.+ /)
-            parent.children << pending
+          if result = scanner.scan(/ ?#<.+>/)
+            parent.children << pending if pending
+            pending = nil
+            match = result.match(/#<(?<title>.*) *(?<url>https?:\/\/.+\.\S+) *(?<title>.*)>/)
+            if match[:url].match(/\.(png|jpg|jpeg|svg)/)
+              parent.children << ImageNode.new(url: match[:url], title: match[:title])
+              next
+            end
+            parent.children << LinkNode.new(url: match[:url], title: match[:title])
+            next
+          end
+
+          if result = scanner.scan(/(^| )#\S+( |$)/)
+            parent.children << pending if pending
             pending = nil
-            match = result.match(/ #(?<page>.+) /)
-            parent.children << LinkNode.new(page: match[:page])
+            match = result.match(/(^| )#(?<url>\S+)( |$)/)
+            if match[:url].match(/\.(png|jpg|jpeg|svg)/)
+              parent.children << ImageNode.new(url: "/#{match[:url]}")
+              next
+            end
+            parent.children << LinkNode.new(url: "/#{match[:url]}.html", title: match[:url])
             next
           end
 

data/lib/wikitxt/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Wikitxt
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

data/samples/Wikitxt.txt

@@ -0,0 +1,20 @@
+#Wikitxt is a lightweight markup language and a tool for composing #Wiki . The syntax of #Wikitxt can be converted to #HTML and viewed in a browser. When converted to HTML, files can be interlinked.
+
+#Wikitxt is based on the format of lists and paragraphs. Most information can be expressed in list format, and the choice between lists and paragraphs is always changing as you write.
+
+Text decoration is limited to mutual links using hashtags. By utilizing the decoration of mutual links, you can intentionally increase the number of pages in the wiki.
+
+In summary, it's like this:
+
+  Lists
+    Based on the idea that most information can be expressed in lists
+  Paragraphs
+    Paragraphs always have the potential to be listed. They can easily be converted to lists.
+    Paragraphs can also serve as headings.
+  Mutual Links
+    Text decoration is limited to links.
+    Words you want to emphasize should be expressed as wiki pages.
+
+Absolute url is parsed as external link: #<https://example.com Example Domain>
+
+#woman.jpg

data/samples/index.txt

@@ -1,3 +1 @@
-Link to #sample .
-
-これはテストです。
+Link to #Wikitxt .

data/wikitxt.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.authors = ["Moeki Kawakami"]
   spec.email = ["moeki.kawakami@icloud.com"]
 
-  spec.summary = "Most lightweight wiki written by plain text."
-  spec.description = "Most lightweight wiki written by plain text."
+  spec.summary = "Most lightweight markup language and personal knowledge manager or wiki platform."
+  spec.description = "Most lightweight markup language and personal knowledge manager or wiki platform."
   spec.homepage = "https://github.com/kawakamimoeki/wikitxt"
   spec.license = "MIT"
   spec.required_ruby_version = ">= 2.6.0"
@@ -26,7 +26,6 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "sinatra", "~> 4.0"
   spec.add_dependency "thor", "~> 1.3"
   spec.add_dependency "webrick", "~> 1.8"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wikitxt
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Moeki Kawakami
@@ -10,20 +10,6 @@ bindir: exe
 cert_chain: []
 date: 2024-04-13 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: sinatra
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -52,7 +38,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.8'
-description: Most lightweight wiki written by plain text.
+description: Most lightweight markup language and personal knowledge manager or wiki
+  platform.
 email:
 - moeki.kawakami@icloud.com
 executables:
@@ -69,6 +56,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- docs/screenshot.png
 - exe/wikitxt
 - lib/html/layout.html.erb
 - lib/wikitxt.rb
@@ -77,8 +65,9 @@ files:
 - lib/wikitxt/parser.rb
 - lib/wikitxt/renderer.rb
 - lib/wikitxt/version.rb
+- samples/Wikitxt.txt
 - samples/index.txt
-- samples/sample.txt
+- samples/woman.jpg
 - wikitxt.gemspec
 homepage: https://github.com/kawakamimoeki/wikitxt
 licenses:
@@ -104,5 +93,5 @@ requirements: []
 rubygems_version: 3.3.26
 signing_key:
 specification_version: 4
-summary: Most lightweight wiki written by plain text.
+summary: Most lightweight markup language and personal knowledge manager or wiki platform.
 test_files: []

data/samples/sample.txt

@@ -1,17 +0,0 @@
-Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec mauris orci, euismod in tortor eu, condimentum pharetra libero.
-
-Cras at tortor urna. Maecenas nec iaculis nulla.
-
-  Animals:
-    Elephant
-    Giraffe
-    Tiger
-    Penguin
-    Dolphin
-  Foods:
-    Pizza
-    Apple
-    Chocolate
-    Sushi
-    Broccoli
-