inkblot 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5e46ca89bfcf220e489ea3063be9236d694d647ebb1361ffa26b1a02a6836ad3
-  data.tar.gz: 4b1ee88e2e2d838b774090957dd98244707180e59d74e1f9fa45c985151c3a4f
+  metadata.gz: ef19b45336c7174cad3412dc52d59f47452511f55ab5af05ed789e7a867cdc58
+  data.tar.gz: cebcdc588d7ad2cee92fc6b4f985ed27832c6e265c7d0184234de7b0ac4b368f
 SHA512:
-  metadata.gz: dfa7b2b1c6301cc3e34ca3c4e774adf21c76632039957ef6ab79425651685496f7cace767e8f26c9a636265d8f1539b4da5579d1439aec52e7410b6fee874a63
-  data.tar.gz: 451276507b487fcdcc9127a56da09105c7d34424f5858fe6a9b9f3b5c1d1cadd8aecd0835a8fa6d1932d53369a6d79fbeeefc7712c3dc5a720f2ac57476158cf
+  metadata.gz: 42f956ed1b6f3ac8e7be061a581a7854da276f2b09f5550d5389c446cf9ca4bee960637c266960500540a6d29a1d053492cf8fd19e9ec92a3aaf790076f80fe9
+  data.tar.gz: ae6d6e445e77e5aca6d6e00c3c1183599979290c736570b496fed96c85efb94423a28ee50a459f1958b5830601fb47f2b8ce0eac73d57bf00db5da039a2e146f

data/.build.yml

@@ -0,0 +1,29 @@
+image: alpine/latest
+packages:
+  - hut
+  - nodejs
+  - npm
+  - musl-dev
+  - libffi-dev
+  - yaml-dev
+  - ruby
+  - ruby-dev
+  - ruby-bundler
+oauth: "pages.sr.ht/PAGES:RW"
+environment:
+  site: farthergate.com
+  TAILWINDCSS_INSTALL_DIR: node_modules/.bin
+tasks:
+  - test: |
+      cd inkblot
+      npm i tailwindcss @tailwindcss/cli @tailwindcss/typography
+      bundle install --path vendor/bundle
+      bundle exec rake || true
+  - site: |
+      cd inkblot/docs
+      bundle exec ../exe/inkblot build
+  - package: |
+      cd inkblot/docs/_build
+      tar -cvz . > ../../../site.tar.gz
+  - upload: |
+      hut pages publish -d $site site.tar.gz

data/.rspec_status

@@ -0,0 +1,3 @@
+example_id                  | status | run_time        |
+--------------------------- | ------ | --------------- |
+./spec/inkblot_spec.rb[1:1] | passed | 0.00037 seconds |

data/Rakefile

@@ -9,4 +9,8 @@ require "rubocop/rake_task"
 
 RuboCop::RakeTask.new
 
-task default: %i[spec rubocop]
+task :css do
+  system("tailwindcss -i tailwind.css --minify -o lib/inkblot.min.css")
+end
+
+task default: %i[spec rubocop css]

data/docs/inkblot.yml

@@ -1,7 +1,12 @@
 title: Inkblot
+
 nav:
-  Inkblot:
-    Home: /
+  - Inkblot:
+      - index
+  - Documentation:
+      - install
+      - getting-started
+      - tailwind
 
 nav-end:
   Aleks Rutins: https://farthergate.com

data/docs/pages/docs/getting-started.md

@@ -0,0 +1,55 @@
+---
+id: getting-started
+title: Getting Started
+---
+
+# Getting Started
+
+Start by initializing a new project:
+
+~~~ sh
+inkblot init
+~~~
+
+From that, you'll find an `inkblot.yml`, a `.gitignore`, and a `pages/index.md` file.
+
+Run the development server:
+
+~~~ sh
+inkblot dev
+~~~
+
+And visit <http://localhost:3000> to see your documentation.
+
+## General Structure
+
+Let's take a look around your project.
+
+First of all, the `inkblot.yml` file describes general information about your site, along with navigation. The default looks like this:
+
+~~~ yaml
+---
+title: Documentation
+nav:
+- :Documentation:
+  - index
+~~~
+
+_If this looks a little strange for YAML, it's the default dump output from Ruby's Psych &mdash; you can just write normal YAML._
+
+You're going to want to change the site title. When you want to add a page, add its `id` frontmatter property to a section in the `nav` key.
+
+`pages/index.md` should look something like this:
+
+~~~ markdown
+---
+id: index
+title: Home
+---
+
+# Home
+~~~
+
+Again, the `id` is what you'll reference it by in the navigation, and the `title` will show up in the navigation and in the page title.
+
+Just write Markdown (Kramdown-flavored) as you usually would anywhere under `pages/`, and use `inkblot build` to build the site to `_build/`.

data/docs/pages/docs/install.md

@@ -0,0 +1,14 @@
+---
+id: install
+title: Installation
+---
+
+# Installation
+
+Install Inkblot from RubyGems:
+
+~~~ sh
+gem install inkblot
+~~~
+
+And move on to getting started.

data/docs/pages/docs/tailwind.md

@@ -0,0 +1,8 @@
+---
+id: tailwind
+title: TailwindCSS
+---
+
+# TailwindCSS
+
+Inkblot comes with prebuilt Tailwind-based styles for its own UI, but if you want to style your own content as well, you can add a `tailwind.css` file, which will be automatically picked up and automatically built.

data/docs/pages/index.md

@@ -1,5 +1,7 @@
 ---
+id: index
 title: Home
 ---
 
-# Home
+# Inkblot
+Inkblot is a simple static documentation generator designed for minimal configuration, based on [Phlexite](https://phlexite.farthergate.com).

data/docs/pages/test.md

@@ -0,0 +1,4 @@
+---
+title: Test
+section: Hello World
+---

data/docs/pages/test2.md

@@ -0,0 +1,4 @@
+---
+title: Test 2
+section: Hello World
+---

data/lib/inkblot/cli.rb

@@ -8,11 +8,12 @@ require "psych"
 require "fileutils"
 require "rouge"
 
+require_relative "pages"
 require_relative "markdown_page"
 
 module Inkblot
   class << self
-    attr_accessor :config
+    attr_accessor :config, :navigation
   end
 
   class Cli < Phlexite::Cli::Cli
@@ -20,44 +21,50 @@ module Inkblot
     def init(path = ".")
       FileUtils.mkdir_p path
       write_tmpl(path, ".gitignore", "_build")
-      write_tmpl(path, "tailwind.css", "@import 'tailwindcss';\n@plugin '@tailwindcss/typography';")
+
+      write_tmpl(path, "inkblot.yml", Psych.dump({
+                                                   "title" => "Documentation",
+                                                   "nav" => [
+                                                     { "Documentation": ["index"] }
+                                                   ]
+                                                 }))
 
       FileUtils.mkdir_p File.join(path, "pages")
-      write_tmpl(path, "pages/index.md", '---\ntitle: Home\n---\n\n# Home')
+      write_tmpl(path, "pages/index.md", "---\nid: index\ntitle: Home\n---\n\n# Home")
     end
 
     def build
-      Phlexite::Site.new do |s|
-        puts "\e[1m==> Building site"
-
-        Inkblot.config = Psych.load_file "inkblot.yml" if File.file? "inkblot.yml"
-
-        Inkblot.config ||= {
-          "title" => "Documentation",
-          "nav" => {
-            "Home" => {
-              "Home" => "/"
-            }
+      spin do
+        Phlexite::Site.new do |s|
+          Inkblot.config = Psych.load_file "inkblot.yml" if File.file? "inkblot.yml"
+
+          Inkblot.config ||= {
+            "title" => "Documentation",
+            "nav" => [
+              { "Documentation": ["index"] }
+            ]
           }
-        }
 
-        Tailwindcss::Phlexite.build s, "tailwind.css", "tailwind.css" if File.file? "tailwind.css"
+          Inkblot.navigation = Inkblot.config["nav"] || {}
 
-        s.mount "assets", on: "/" if File.file? "assets"
+          content = Phlexite::Content::Collection.new("pages/**/*.md", Inkblot::MarkdownPage, prefix: "pages")
+          Pages.populate content
+          content.build(s)
 
-        s.page "syntax.css", proc {
-          Rouge::Themes::Base16.make_dark!
-          Rouge::Themes::Base16.style(Rouge::Token::Tokens::Text, bg: "#00000000")
-          Rouge::Themes::Base16.new(scope: "pre > code").render
-        }
+          Tailwindcss::Phlexite.build s, "tailwind.css", "tailwind.css" if File.file? "tailwind.css"
 
-        s.page "inkblot.min.css", proc {
-          File.read(File.join(File.expand_path(File.dirname(File.dirname(__FILE__))), "inkblot.min.css"))
-        }
+          s.mount "assets", on: "/" if File.file? "assets"
 
-        Phlexite::Content::Collection.new("pages/**/*.md", Inkblot::MarkdownPage, prefix: "pages").build(s)
+          s.page "syntax.css", proc {
+            Rouge::Themes::Base16.make_dark!
+            Rouge::Themes::Base16.style(Rouge::Token::Tokens::Text, bg: "#00000000")
+            Rouge::Themes::Base16.new(scope: "pre > code").render
+          }
 
-        puts "\e[1m==> Build finished"
+          s.page "inkblot.min.css", proc {
+            File.read(File.join(File.expand_path(File.dirname(File.dirname(__FILE__))), "inkblot.min.css"))
+          }
+        end
       end
     end
 

data/lib/inkblot/layout.rb

@@ -4,8 +4,9 @@ require "phlex"
 
 module Inkblot
   class Layout < ::Phlex::HTML
-    def initialize(title)
+    def initialize(title, id)
       @title = title
+      @id = id
     end
 
     def nav_link(url, klass = "", &block)
@@ -14,7 +15,7 @@ module Inkblot
       end
     end
 
-    def pages = Inkblot.config["nav"] || {}
+    def pages = Inkblot.navigation || {}
     def nav_end = Inkblot.config["nav-end"] || {}
 
     def view_template(&block)
@@ -34,10 +35,14 @@ module Inkblot
           aside(class: "p-5 min-w-[15%] border-r border-gray-200 bg-gray-100 dark:bg-[#131314] dark:border-stone-700 fixed top-0 left-0 h-screen") do
             nav(style: "display: flex; flex-direction: column; justify-content: space-between; height: 100%;") do
               ul do
-                pages.each do |section, pgs|
-                  li(class: "font-bold text-gray-500 dark:text-gray-400 py-2 text-sm") { section }
-                  pgs.each do |title, path|
-                    nav_link(path, @title == title ? "text-gray-900" : "") { title }
+                pages.each do |section|
+                  li(class: "font-bold text-gray-500 dark:text-gray-400 py-2 text-sm") { section.keys[0] }
+                  section.values[0].each do |page|
+                    title = Pages.pages[page][:fm]["title"]
+                    cur_page = (@id ? @id == page : @title == title)
+                    nav_link(Pages.pages[page][:out], cur_page ? "text-gray-900" : "") do
+                      Pages.pages[page][:fm]["title"]
+                    end
                   end
                 end
               end

data/lib/inkblot/markdown_page.rb

@@ -4,11 +4,10 @@ require "kramdown"
 require_relative "layout"
 
 module Inkblot
+  ###
   class MarkdownPage < ::Phlex::HTML
-    def initialize; end
-
     def view_template
-      render Layout.new(@front_matter["title"]) do
+      render Layout.new(@front_matter["title"], @front_matter["id"]) do
         div(class: "prose dark:prose-invert mx-auto pb-10") do
           raw safe Kramdown::Document.new(@content, { syntax_highlighter: :rouge }).to_html
         end

data/lib/inkblot/pages.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Inkblot
+  ###
+  module Pages
+    class << self
+      attr_accessor :pages
+
+      def populate(content)
+        self.pages = {}
+        content.entries.each do |f|
+          fm = f.read.front_matter
+          pages[fm["id"] || f.out_path] = {
+            fm: fm,
+            out: f.out_path
+          }
+        end
+      end
+    end
+  end
+end

data/lib/inkblot/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Inkblot
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/tailwind.css

@@ -0,0 +1,2 @@
+@import "tailwindcss" source("./lib");
+@plugin '@tailwindcss/typography';

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: inkblot
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Aleks Rutins
@@ -114,23 +114,31 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".build.yml"
 - ".rspec"
+- ".rspec_status"
 - ".rubocop.yml"
 - LICENSE.txt
 - README.md
 - Rakefile
 - docs/.gitignore
 - docs/inkblot.yml
+- docs/pages/docs/getting-started.md
+- docs/pages/docs/install.md
+- docs/pages/docs/tailwind.md
 - docs/pages/index.md
-- docs/tailwind.css
+- docs/pages/test.md
+- docs/pages/test2.md
 - exe/inkblot
 - lib/inkblot.min.css
 - lib/inkblot.rb
 - lib/inkblot/cli.rb
 - lib/inkblot/layout.rb
 - lib/inkblot/markdown_page.rb
+- lib/inkblot/pages.rb
 - lib/inkblot/version.rb
 - sig/inkblot.rbs
+- tailwind.css
 homepage: https://inkblot.farthergate.com
 licenses:
 - MIT
@@ -152,7 +160,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.3
 specification_version: 4
 summary: A documentation generator for Phlexite
 test_files: []

data/docs/tailwind.css

@@ -1,2 +0,0 @@
-@import "tailwindcss";
-@plugin "@tailwindcss/typography";