bridgetown-stoa 0.1.0 → 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 4a78f506b84ad2518d27d4f7cb6cfc133fcd3dae4dadd2622d3f3698ede1dbc3
4
- data.tar.gz: d567d1a4059a6da89a02d9124a47230557042332983e2a13cdaeb7cbb1e4fb83
3
+ metadata.gz: cd608896b8fe6337dd6f18ea4142689a7075fb8b083b2e818f8e7fb2581bef94
4
+ data.tar.gz: c701e091bf21dbcdfc797186baf25a8c091ff39b5396db1ca7a41a3dccecd5cf
5
5
  SHA512:
6
- metadata.gz: 3039e265e94aa9571ee8d8846cb988f2dc73bc75f2f8391e393db22684faea404747728e76c3434acff558faa576ea40d39769180f0e59e6395b419717b41795
7
- data.tar.gz: c331e8d344ac1f991822edebd681a86e64e07cf7ee745bb343f447314bd397e5e5944d131a296ef9f5e7dba180485f30d23037b09e42cba51d410639bd02fe44
6
+ metadata.gz: 921ab4bca3b8dc1559db5d8bc3837a875643519925a4eed55a257c4b2c4e10444a7d7b404f1589f1d6c06c761ba83c03a10fdf180b2378a33c4275868400585b
7
+ data.tar.gz: bb4431c809b2eb51eb6c432d15c5a0785a0c25ea2762cba781942c97435139d31f93d60e5e68b76f6f847e685046e7e4719c3dfeb112543da8fc388ddf6b0543
data/CHANGELOG.md CHANGED
@@ -9,6 +9,22 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
9
9
 
10
10
  - ...
11
11
 
12
+ ## [0.3.0] - 2026-05-22
13
+
14
+ ### Changed
15
+ - Enabled the `yarn-add` gemspec metadata so Bridgetown sites that install the gem auto-add the `bridgetown-stoa` npm dependency. Matches the idiomatic pattern from `bridgetown-quick-search`. (`yarn-add` and `npm_add` are synonyms inside Bridgetown's plugin manager — the gemspec template's commented `npm_add` is the older name; the ecosystem has standardized on `yarn-add`.)
16
+ - Excluded `frontend/` from the gem's `files` glob. The Tailwind partial belongs in the npm companion only; shipping it in the gem too was duplicate distribution.
17
+ - Test fixture initializer now passes `require_gem: false` to `init :"bridgetown-stoa"` so Bridgetown's plugin manager doesn't run `install_npm_dependencies` during the test suite (which would inject a self-referencing dep into the gem's own `package.json`). The gem is already loaded by `test/helper.rb`, so the re-require was redundant anyway.
18
+
19
+ ## [0.2.0] - 2026-05-22
20
+
21
+ ### Added
22
+ - Tailwind v4 source partial at `frontend/styles/bridgetown-stoa.css`, shipped via a companion `bridgetown-stoa` npm package. Defines `--color-stoa-*` and `--font-stoa-*` design tokens (light + dark) in an `@theme` block, sets up class-strategy dark mode via `@custom-variant dark`, and applies a baseline `html` style. Host sites `@import "bridgetown-stoa"` and `@source` the layouts from their `frontend/styles/index.css`.
23
+ - `script/release` now also runs `npm publish` after the gem release, and pre-flights `npm whoami` so it bails before the gem push if credentials are missing.
24
+
25
+ ### Fixed
26
+ - `bridgetown-stoa/layout` no longer prepends `"Index | "` to `<title>` on the home page when `src/index.md` has no explicit `title:` front-matter. (#8)
27
+
12
28
  ## [0.1.0] - 2026-05-22
13
29
 
14
30
  ### Changed
data/README.md CHANGED
@@ -22,6 +22,29 @@ Then `bundle install` and add to `config/initializers.rb`:
22
22
  init :"bridgetown-stoa"
23
23
  ```
24
24
 
25
+ ### Styles (Tailwind v4)
26
+
27
+ Stoa ships its styles as a Tailwind v4 source partial in a companion npm package (`bridgetown-stoa`), so they compose with your site's Tailwind pipeline (tree-shaken, token-overrideable).
28
+
29
+ ```shell
30
+ npm install bridgetown-stoa
31
+ ```
32
+
33
+ Then in `frontend/styles/index.css`, after `@import "tailwindcss";`, add two lines:
34
+
35
+ ```css
36
+ @import "tailwindcss";
37
+ @source "../../node_modules/bridgetown-stoa/layouts/**/*.serb";
38
+ @import "bridgetown-stoa";
39
+ ```
40
+
41
+ - `@source` tells Tailwind to scan Stoa's layouts for utility-class usage.
42
+ - `@import "bridgetown-stoa"` pulls in the `@theme` tokens (`--color-stoa-*`, `--font-stoa-*`) and a small `@layer base` that styles `html` with the theme colors.
43
+
44
+ Override any token by redeclaring it in your own `@theme` block after the import.
45
+
46
+ Stoa uses Tailwind's **class-strategy dark mode** (`html.dark`). Toggle the `dark` class on `<html>` to switch themes; a default JS toggle that follows `prefers-color-scheme` will ship in a later release.
47
+
25
48
  ## Usage
26
49
 
27
50
  One layout is registered: `bridgetown-stoa/layout`. Apply it via front matter:
@@ -11,14 +11,12 @@ Gem::Specification.new do |spec|
11
11
  spec.homepage = "https://github.com/Guided-Rails/bridgetown-stoa"
12
12
  spec.license = "MIT"
13
13
 
14
- spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r!^(test|script|spec|features)/!) }
14
+ spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r!^(test|script|spec|features|frontend)/!) }
15
15
  spec.test_files = spec.files.grep(%r!^test/!)
16
16
  spec.require_paths = ["lib"]
17
- # Uncomment this if you wish to supply a companion NPM package and/or command features:
18
- # spec.metadata = {
19
- # "npm_add" => "bridgetown-stoa@#{BridgetownStoa::VERSION}",
20
- # "bridgetown_features" => "true"
21
- # }
17
+ spec.metadata = {
18
+ "yarn-add" => "bridgetown-stoa@#{BridgetownStoa::VERSION}",
19
+ }
22
20
 
23
21
  spec.required_ruby_version = ">= 3.2"
24
22
 
@@ -4,7 +4,10 @@
4
4
  <meta charset="utf-8">
5
5
  <meta name="viewport" content="width=device-width, initial-scale=1">
6
6
  <title>
7
- {% if resource.data.title %}{{ resource.data.title }} | {% end %}{{ site.metadata.title }}
7
+ {% if resource.data.title != "Index" %}
8
+ {{ resource.data.title }} |
9
+ {% end %}
10
+ {{ site.metadata.title }}
8
11
  </title>
9
12
  {% if resource.data.description %}
10
13
  <meta name="description" content="{{ resource.data.description }}">
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module BridgetownStoa
4
- VERSION = "0.1.0"
4
+ VERSION = "0.3.0"
5
5
  end
data/package.json ADDED
@@ -0,0 +1,26 @@
1
+ {
2
+ "name": "bridgetown-stoa",
3
+ "version": "0.3.0",
4
+ "description": "Tailwind v4 source partial and layouts for the Stoa Bridgetown documentation theme.",
5
+ "license": "MIT",
6
+ "repository": {
7
+ "type": "git",
8
+ "url": "git+https://github.com/Guided-Rails/bridgetown-stoa.git"
9
+ },
10
+ "homepage": "https://github.com/Guided-Rails/bridgetown-stoa",
11
+ "main": "frontend/styles/bridgetown-stoa.css",
12
+ "style": "frontend/styles/bridgetown-stoa.css",
13
+ "exports": {
14
+ ".": "./frontend/styles/bridgetown-stoa.css",
15
+ "./layouts/*": "./layouts/*"
16
+ },
17
+ "files": [
18
+ "frontend/styles/",
19
+ "layouts/",
20
+ "README.md",
21
+ "LICENSE.txt"
22
+ ],
23
+ "peerDependencies": {
24
+ "tailwindcss": "^4.0.0"
25
+ }
26
+ }
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: bridgetown-stoa
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.0
4
+ version: 0.3.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Abdullah Hashim
@@ -83,10 +83,12 @@ files:
83
83
  - layouts/bridgetown-stoa/layout.serb
84
84
  - lib/bridgetown-stoa.rb
85
85
  - lib/bridgetown-stoa/version.rb
86
+ - package.json
86
87
  homepage: https://github.com/Guided-Rails/bridgetown-stoa
87
88
  licenses:
88
89
  - MIT
89
- metadata: {}
90
+ metadata:
91
+ yarn-add: bridgetown-stoa@0.3.0
90
92
  rdoc_options: []
91
93
  require_paths:
92
94
  - lib