alister 1.0.0 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e0d1ba1fe8f39f425a504f7e02454b0182b7ba51673c63482fc51ab9c28e6260
-  data.tar.gz: 4bb178fcfd4f5fc2c12347392e578db460f50924a158ed87518a451a9b43c677
+  metadata.gz: 1cd81cc14ddfe50ac97bbf8da56da8ea7bbedf031eae186de74a990b76655866
+  data.tar.gz: 3719e5311f3bfb4380192db31907458cc4b6c0feea05f3433bbd78dcdf49166d
 SHA512:
-  metadata.gz: 2d3cf3db9d806285fdef30115824650ca7dfe74e5b6ec19482c6a0b0bbcacfd1c15cd44000a4924f5dd42bc1cf720328dcf1b76626f59f693b0346887a9ccbc0
-  data.tar.gz: cbfc01a0d65870d5648ec1377b4f05c36ceed89e26d41fdf352c5c11a3d35adda63a84633c79cadf51472a680e087959dd9d074aad55ab3368e174dc14d87d8d
+  metadata.gz: 7b19e246163e020d92c57746bf72e8971e3e62f65ef9d75bd270d02aa4f2f9535411dd4b55d358a9019efa9b3df92a44e7b662180c78616a7e5247a452076496
+  data.tar.gz: 9c9e437e5114b333615dded931809d9a2fb6903f6d90af5a420da14a039c31dbd98642f4d16fb8a49957190124565f4e7b9e031dbb2b905a8511cc70ade101a6

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## [Released]
 
+## [1.0.2] - 2025-08-12
+
+- Fixed documentation (forgot p is supposed to be para)
+
+## [1.0.1] - 2025-08-12
+
+- Removed lib/html/generate_yard_tags.rb from build
+
 ## [1.0.0] - 2025-08-12
 
 - Initial release

data/README.md

@@ -4,6 +4,20 @@ A super minimal ruby solution to static site generation. This gem allows you to
 
 ## Installation
 
+Install all the dependencies first:
+
+For Ubuntu, Debian:
+
+    sudo apt-get install libjpeg-dev libpng-dev libtiff-dev libwebp-dev
+
+For Fedora, CentOS:
+
+    sudo dnf install libjpeg-devel libpng-devel libtiff-devel libwebp-devel
+
+For Mac OS:
+
+    brew install libjpg libpng libtiff webp
+
 Install the gem and add to the application's Gemfile by executing:
 
 ```bash
@@ -18,7 +32,26 @@ gem install alister
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+require 'alister'
+
+root_page = Alister.html do
+  doctype
+  html lang: "en" do
+    head do
+      meta charset: "utf-8"
+      meta name: "viewport", content: "width=device-width, initial-scale=1"
+    end
+    body do
+      div id: "app" do
+        para "hello world"
+      end
+    end
+end
+s = Alister::Site.new
+s.route "/", root_page
+s.build "./build"
+```
 
 ## Development
 

data/lib/alister/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Alister
-  VERSION = '1.0.0'
+  VERSION = '1.0.2'
 end

data/lib/alister.rb

@@ -17,7 +17,7 @@ require_relative 'self'
 #       end
 #       body do
 #         div id: "app" do
-#           p "hello world"
+#           para "hello world"
 #         end
 #       end
 #   end

data/lib/site.rb

@@ -35,7 +35,7 @@ module Alister
     # Creates a new html page on path
     # @param path [String] route path on where to build
     # @param page [HTML::Builder, HTML::Element, String] content that will be put inside the page
-    # return [void]
+    # @return [void]
     def route(path, page)
       @routes << Page.new(path, page)
     end
@@ -43,14 +43,14 @@ module Alister
     # Creates a new file on path
     # @param path [String] route path on where to build, including the name of the file
     # @param string [String] content that will be put inside the file
-    # return [void]
+    # @return [void]
     def file(path, string)
       @files << Page.new(path, string)
     end
 
     # Builds the site
     # @param path [String] path on where to build
-    # return [void]
+    # @return [void]
     def build_to(path)
       @path = path
       @routes.each do |route|
@@ -74,14 +74,14 @@ module Alister
     #     file "**/*"
     #     build_to_and_reset "./build/assets/"
     #   end
-    # return [void]
+    # @return [void]
     def assets(&block)
       assets = Alister::Assets.new
       assets.instance_eval(&block)
     end
 
     # Resets the site builder for next build
-    # return [void]
+    # @return [void]
     def reset
       @path = nil
       @routes = []
@@ -90,7 +90,7 @@ module Alister
 
     # Builds and then resets the site builder
     # @param path [String] path on where to build
-    # return [void]
+    # @return [void]
     def build_to_and_reset(path)
       build_to(path)
       reset

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: alister
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.2
 platform: ruby
 authors:
 - Lain Madeline
@@ -68,18 +68,17 @@ files:
 - lib/assets.rb
 - lib/html/builder.rb
 - lib/html/element.rb
-- lib/html/generate_yard_tags.rb
 - lib/html/html.rb
 - lib/html/yard_tags.rb
 - lib/self.rb
 - lib/site.rb
-homepage: https://github.com/Lain62/Alister
+homepage: https://github.com/Lain62/alister
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/Lain62/Alister
-  source_code_uri: https://github.com/Lain62/Alister
-  changelog_uri: https://github.com/Lain62/Alister/blob/main/CHANGELOG.md
+  homepage_uri: https://github.com/Lain62/alister
+  source_code_uri: https://github.com/Lain62/alister
+  changelog_uri: https://github.com/Lain62/alister/blob/main/CHANGELOG.md
 rdoc_options: []
 require_paths:
 - lib

data/lib/html/generate_yard_tags.rb

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-# THIS IS JUST TO GENERATE YARD TAGS, IGNORE
-
-require_relative 'builder'
-
-str = +"# frozen_string_literal: true\n\n"
-str << "module Alister\n"
-str << "  module HTML\n"
-str << "    class Builder\n\n"
-Alister::HTML::TAGS.each do |tag|
-  str << "      # @!method #{tag}(value = nil, **args, &block)\n"
-  tag = :p if tag == :para
-  str << "      #   Creates a <#{tag}> element and puts it to {#elements}\n"
-  str << "      #   @param value [String] The value of the element\n"
-  str << "      #   @param args [Hash] The attributes of the element\n"
-  str << "      #   @return [void]\n"
-  str << "      #   @yield Create child elements of <#{tag}>\n"
-  str << "\n"
-end
-str << "    end\n"
-str << "  end\n"
-str << "end\n"
-
-File.delete('./yard_tags.rb') if File.exist? './yard_tags.rb'
-file = File.new('./yard_tags.rb', 'w+')
-file.write(str)
-file.close
-puts '[LOG] Created yard_tags.rb'