isola 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c9ea7b839acee149cdc001dae2606001e8393efebafb19bcbea8852a694bc7a0
-  data.tar.gz: 95435cd787ea492043c2b8f0f62b8585e3265f4e7d5f6f315e1705e322700938
+  metadata.gz: 78a20d7d0b5cf6c979a08cd3cb3180713278bef47ac3fdd9d318da746d437d70
+  data.tar.gz: f92155399e18243068cd270778684e5ef9ff6a7482118fa7d1dfe7ce863f355a
 SHA512:
-  metadata.gz: e80d3f35ca2f20a8d449fd224e2b3f580c3d32161e3d8ec0259711fe5be6438f28d5f0c89dc663c693e42283b3d1673916c0ad7fe28620f444d7f77f9a30d297
-  data.tar.gz: 289d16edbc4e8c3e9762015e6088a15e34a88af9c4874ddeba90bee78c2457cdabf15708fcc81c1058b468732022941f0f5b99c081557f6032dc1c3ae57ab416
+  metadata.gz: f7c7a4c8c0c2f17c7bfc7f19f56d9b64449968510f449f4bcabbba1336f485b633035a130e00945b5e22e14abd22499216b709797918fae5534cbf3312fc1f0d
+  data.tar.gz: f9d0abda752892015b7daac37fb8fe6766bda464c6e3201b7f167fef5636fca2f2445445c67ddc41df6984956ae82db6f81ce25aa2860661cf66556b4b504ecb

data/README.md

@@ -1,6 +1,7 @@
 # isola
+[![Gem Version](https://badge.fury.io/rb/isola.svg)](https://badge.fury.io/rb/isola)
 
-Super simple static site generator using erb.
+Super simple static site generator using eRuby as a template engine. Supports a multilingual website. Blogging features are not yet implemented.
 
 ## Installation
 
@@ -8,7 +9,7 @@ Super simple static site generator using erb.
 bundle add isola
 ```
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+If you are not using Bundler to manage dependencies, install the gem by executing:
 
 ```bash
 gem install isola
@@ -16,14 +17,18 @@ gem install isola
 
 ## Usage
 
-1. place markdown files in your directory
+1. Place markdown files in your directory.
 2. `isola build`
 
-See [Usage Guide](USAGE.md) / [使い方ガイド](USAGE.ja.md) for details.
+Refer to the [Usage Guide](USAGE.md) / [使い方ガイド](USAGE.ja.md) for more information.
+
+## Websites Built with Isola
+
+* [群島舎/Guntosha](https://skoji.dev) ([source](https://github.com/skoji/skoji-dev-web))
 
 ## Development Policy
 
-This project does not use Agentic Coding at all. AI assistance in code reviews is not avoided.
+This project does not use Agentic Coding for development. AI assistance in code reviews is not avoided.
 
 ## License
 

data/USAGE.ja.md

@@ -101,7 +101,7 @@ port: 4444
 
 ## ファイルの処理
 
-Isolaが処理するテンプレートエンジンは現在 **ERB**（`.erb`）と **Markdown**（`.md`, `.markdown`, `.mkd`）のみです。
+Isolaは **ERB**（`.erb`）と **Markdown**（`.md`, `.markdown`, `.mkd`）をビルトインのテンプレートエンジンとしてサポートしています。
 
 拡張子の末尾から順に処理します。例えば `page.md.erb` の場合、まずERBを処理し、次にMarkdownを処理します。
 
@@ -117,6 +117,44 @@ Isolaが処理するテンプレートエンジンは現在 **ERB**（`.erb`）
 
 `_`や`.`で始まるファイル・ディレクトリは自動的に除外されます（`_layouts/`と`_includes/`を除く）。
 
+### Tilt拡張
+
+[Tilt](https://github.com/rtomayko/tilt)がサポートするテンプレートエンジンを、`_config.yaml`の`tilt_extensions`で追加できます。対応するライブラリが利用可能である必要があります（例: `Gemfile`に追加）。
+
+#### SCSS / Sass
+
+`tilt_extensions`に`.scss`や`.sass`を追加します:
+
+```yaml
+tilt_extensions:
+  - .scss
+```
+
+SCSS/Sassファイルは自動的にCSSに変換されます。ファイル名に出力用の拡張子を追加する必要はありません。
+
+| ソース | 処理 | 出力 |
+|---|---|---|
+| `style.scss` | SCSS → CSS | `style.css` |
+
+`sass-embedded` gemも必要です。`Gemfile`に追加してください:
+
+```ruby
+gem "sass-embedded"
+```
+
+#### その他のTilt拡張
+
+その他のTilt対応エンジン（例: `.nokogiri`）では、出力拡張子は自動推定されません。ファイル名に出力したい拡張子を含めてください:
+
+```yaml
+tilt_extensions:
+  - .nokogiri
+```
+
+| ソース | 処理 | 出力 |
+|---|---|---|
+| `data.xml.nokogiri` | Nokogiriテンプレート → XML | `data.xml` |
+
 ## 多言語対応
 
 Isolaは多言語サイトの構築をサポートしています。デフォルト言語のページはサイトルートに、その他の言語は言語コード名のサブディレクトリに配置します。

data/USAGE.md

@@ -101,7 +101,7 @@ The server watches for file changes and automatically rebuilds the site. HTML pa
 
 ## File Processing
 
-Isola currently supports only **ERB** (`.erb`) and **Markdown** (`.md`, `.markdown`, `.mkd`) as template engines.
+Isola supports **ERB** (`.erb`) and **Markdown** (`.md`, `.markdown`, `.mkd`) as built-in template engines.
 
 Extensions are processed from right to left. For example, `page.md.erb` is first processed as ERB, then as Markdown.
 
@@ -117,6 +117,44 @@ If an extension remains after processing, it is kept as-is. If no extension rema
 
 Files and directories starting with `_` or `.` are excluded automatically (except `_layouts/` and `_includes/`).
 
+### Tilt Extensions
+
+You can add additional template engines supported by [Tilt](https://github.com/rtomayko/tilt) via `tilt_extensions` in `_config.yaml`. The corresponding library must be available in your environment (e.g. added to your `Gemfile`).
+
+#### SCSS / Sass
+
+Add `.scss` or `.sass` to `tilt_extensions`:
+
+```yaml
+tilt_extensions:
+  - .scss
+```
+
+SCSS/Sass files are automatically converted to CSS. No extra extension is needed in the filename.
+
+| Source | Processing | Output |
+|---|---|---|
+| `style.scss` | SCSS → CSS | `style.css` |
+
+You also need the `sass-embedded` gem. Add it to your `Gemfile`:
+
+```ruby
+gem "sass-embedded"
+```
+
+#### Other Tilt Extensions
+
+For other Tilt-supported engines (e.g. `.nokogiri`), the output extension is not inferred automatically. Include the desired output extension in the filename:
+
+```yaml
+tilt_extensions:
+  - .nokogiri
+```
+
+| Source | Processing | Output |
+|---|---|---|
+| `data.xml.nokogiri` | Nokogiri template → XML | `data.xml` |
+
 ## Multi-Language Support
 
 Isola supports building multi-language sites. Pages for the default language live at the site root, while other languages are placed in subdirectories named by language code.
@@ -161,6 +199,8 @@ In addition to the standard template variables, multi-language sites provide:
 
 - `page[:lang]` — the language of the current page (e.g. `:ja`, `:en`)
 - `page[:translations]` — a hash of `{lang: url_path}` (URL paths starting with `/`, suitable for `href` attributes) for all available translations of the current page
+- `site.language_label(lang)` — returns the `label` string for the given language (e.g. `site.language_label(:ja)` → `"日本語"`). Returns `nil` if `languages` is not configured.
+- `lang_path(path)` — returns the URL path for the given page path localized to the current page's language (e.g. `lang_path("foo.html")` → `"/en/foo.html"` when rendered in an English page)
 
 #### Generating hreflang Links
 
@@ -172,6 +212,26 @@ Use `page[:translations]` to output alternate-language links:
 <% end %>
 ```
 
+#### Language Switcher
+
+Use `site.language_label` and `page[:translations]` to build a language switcher:
+
+```erb
+<ul>
+  <% page[:translations].each do |lang, url| %>
+    <li><a href="<%= url %>"><%= site.language_label(lang) %></a></li>
+  <% end %>
+</ul>
+```
+
+#### Generating Localized Links
+
+Use `lang_path` to generate links to other pages within the same language:
+
+```erb
+<a href="<%= lang_path("about.html") %>">About</a>
+```
+
 ### Output
 
 The output mirrors the source structure:

data/lib/isola/site.rb

@@ -12,8 +12,8 @@ module Isola
                       host: "127.0.0.1",
                       languages: {},
                       port: 4444}.freeze
-    SUPPORTED_TILT_EXT = [".erb", ".md", ".markdown", ".mkd", ".html"]
-    EXT_MAP = {".md" => ".html", ".mkd" => ".html", ".markdown" => ".html", ".html" => ".html", "" => ".html"}
+    SUPPORTED_TILT_EXTS = [".erb", ".md", ".markdown", ".mkd", ".html"]
+    EXT_MAP = Hash.new("").merge({".md" => ".html", ".mkd" => ".html", ".markdown" => ".html", ".html" => ".html", ".scss" => ".css", ".sass" => ".css", "" => ".html"})
     def initialize(config)
       @config = DEFAULT_CONFIG.merge(YAML.safe_load(config, symbolize_names: true) || {})
       @config[:default_language] = @config[:default_language].to_sym
@@ -23,6 +23,7 @@ module Isola
         default_language: default_language,
         languages: languages.keys
       )
+      @supported_tilt_exts = SUPPORTED_TILT_EXTS.union(@config[:tilt_extensions] || [])
       collect_files
     end
 
@@ -43,7 +44,7 @@ module Isola
     end
 
     def ext_to_process_with_tilt? ext
-      SUPPORTED_TILT_EXT.include? ext
+      @supported_tilt_exts.include? ext
     end
 
     def process_extensions(path)
@@ -76,7 +77,6 @@ module Isola
     end
 
     def url_path_for(path)
-      # will support base_url for the future.
       File.join("/", path)
     end
 
@@ -152,7 +152,7 @@ module Isola
           return nil unless p
           if ext_to_process_with_tilt?(File.extname(p))
             translations = translations_for(resolved, store)
-            Source.new(p, read_in_site(p), lang: lang, translations: translations)
+            Source.new(p, read_in_site(p), root_dir: @config[:root_dir], lang: lang, translations: translations)
           else
             StaticFile.new(p)
           end

data/lib/isola/source.rb

@@ -3,8 +3,9 @@ require "yaml"
 module Isola
   class Source
     attr_reader :filepath, :meta, :content
-    def initialize filepath, text, lang:, translations: {}
+    def initialize filepath, text, lang:, root_dir: "", translations: {}
       @filepath = filepath
+      @root_dir = root_dir
       @meta, @content = if (m = text.match(/\A---\s*\n(.+?)^---\s*\n(.*)\z/m))
         [YAML.safe_load(m[1], symbolize_names: true) || {}, m[2]]
       else
@@ -21,7 +22,8 @@ module Isola
     def render(context, site, params = {})
       rendered = @content.dup
       output_path = site.process_extensions(@filepath) do |current_path, _ext|
-        rendered = Tilt.new(current_path) { rendered }.render(context, params)
+        path = File.join(@root_dir, current_path)
+        rendered = Tilt.new(path) { rendered }.render(context, params)
       end
       [rendered, output_path]
     end

data/lib/isola/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Isola
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: isola
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Satoshi Kojima