yass 0.0.1 → 0.1.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 +4 -4
- data/README.md +95 -3
- data/bin/yass +4 -0
- data/lib/yass/cli/helpers.rb +4 -0
- data/lib/yass/cli/runner.rb +14 -1
- data/lib/yass/config.rb +6 -1
- data/lib/yass/liquid_filters.rb +2 -0
- data/lib/yass/liquid_tags.rb +16 -0
- data/lib/yass/liquid_template.rb +7 -14
- data/lib/yass/source.rb +1 -1
- data/lib/yass/version.rb +1 -1
- data/lib/yass.rb +2 -1
- metadata +22 -8
- data/lib/yass/liquid_highlight_tag.rb +0 -14
- /data/{lib/template → site-template}/layouts/default.html.liquid +0 -0
- /data/{lib/template → site-template}/site/assets/highlight-default.css +0 -0
- /data/{lib/template → site-template}/site/assets/highlight.min.js +0 -0
- /data/{lib/template → site-template}/site/index.default.html.liquid +0 -0
- /data/{lib/template → site-template}/templates/css_links.liquid +0 -0
- /data/{lib/template → site-template}/templates/js_scripts.liquid +0 -0
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: d92f535716945017dd1fc1871e65902172c2ca4b4fa40836bb802767e7be8c77
|
|
4
|
+
data.tar.gz: 3123fbeb9e5b3ff90e51c0f3900e6634b656d95a3040239dcdf888901b6a2ab6
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 19e3c50da3cc3a30894e8fe954a4de5aaf1b215d8991d05ffb4df0a120a1530b5d5db21de69e16cd5febb6cdf2eeae6750813f7313fc305e6781e95d37881919
|
|
7
|
+
data.tar.gz: 57d632fb56ff222d1e9629c4df77e2f27749680d161992092ea8266f80d554aaca62254e5bc47bd230c7930cdf458cdc3b3b3bce2dbce8fa3f9fd3ff0fb130fc
|
data/README.md
CHANGED
|
@@ -2,9 +2,9 @@
|
|
|
2
2
|
|
|
3
3
|
Yet Another Static Site (generator)
|
|
4
4
|
|
|
5
|
-
Yass is an incredibly
|
|
5
|
+
Yass is an incredibly un-opinionated static site generator. Here's how it works:
|
|
6
6
|
|
|
7
|
-
*
|
|
7
|
+
* Write everything by hand under `site/`.
|
|
8
8
|
* Everything under `site/` is copied to `dist/`.
|
|
9
9
|
* [Markdown](https://commonmark.org/) (`.md`) and [Liquid](https://shopify.github.io/liquid/) (`.liquid`) files are processed.
|
|
10
10
|
* Liquid layouts and templates can be placed into `layouts/` and `templates/`.
|
|
@@ -14,6 +14,8 @@ Yass is an incredibly unopinioanted static site generator. Here's how it works:
|
|
|
14
14
|
|
|
15
15
|
## Getting started
|
|
16
16
|
|
|
17
|
+
Starting from an empty page isn't fun, so `yass init` will create a skeleton site for you.
|
|
18
|
+
|
|
17
19
|
```bash
|
|
18
20
|
$ gem install yass
|
|
19
21
|
$ yass init blog
|
|
@@ -40,7 +42,97 @@ If you're building for local viewing, use the `--local` option. It ensures any g
|
|
|
40
42
|
yass build --local
|
|
41
43
|
```
|
|
42
44
|
|
|
43
|
-
|
|
45
|
+
Use the `watch` command to continually build your site as files change.
|
|
46
|
+
|
|
47
|
+
```bash
|
|
48
|
+
yass watch
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
## Layouts
|
|
52
|
+
|
|
53
|
+
Layouts live in `layouts/` and will be applied to files with matching names. The `content` variable contains the data to render in the layout.
|
|
54
|
+
|
|
55
|
+
*layouts/page.html.liquid*
|
|
56
|
+
|
|
57
|
+
```html
|
|
58
|
+
<!DOCTYPE html>
|
|
59
|
+
<html lang="en">
|
|
60
|
+
<head>
|
|
61
|
+
<title>{{ page.title }}</title>
|
|
62
|
+
</head>
|
|
63
|
+
<body>{{ content }}</body>
|
|
64
|
+
</html>
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
This template will be applied to files with names like `foo.page.html` and `foo.page.html.liquid`. The `.page` part of the name will be removed from the final file.
|
|
68
|
+
|
|
69
|
+
Since Markdown files (`foo.page.md`, `foo.page.md.liquid`) are converted to `.html` files, they'll also use `.html` layouts.
|
|
70
|
+
|
|
71
|
+
## Templates
|
|
72
|
+
|
|
73
|
+
Templates live in `templates/` and can be used in any `.liquid` files.
|
|
74
|
+
|
|
75
|
+
*templates/greeting.liquid*
|
|
76
|
+
|
|
77
|
+
```html
|
|
78
|
+
<p>Hi, my name is {{ name }}</p>
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
Render the above template with `{% render "greeting", name: "Pleck" %}`.
|
|
82
|
+
|
|
83
|
+
NOTE: Liquid is pretty strict about template filenames. They must match `^[a-zA-Z0-9_]\.liquid$`.
|
|
84
|
+
|
|
85
|
+
## Liquid variables
|
|
86
|
+
|
|
87
|
+
### page
|
|
88
|
+
|
|
89
|
+
An object representing the current page. Properties:
|
|
90
|
+
|
|
91
|
+
* `title` A titleized version of the filename (e.g. *My File* from *my-file.html*)
|
|
92
|
+
* `url` URL path to the file (note that *index.html* stripped unless the `--local` option is used)
|
|
93
|
+
* `path` Same as `url` except *index.html* is never stripped
|
|
94
|
+
* `dirname` Directory file is in (e.g. *foo/bar* from *foo/bar/zorp.html*)
|
|
95
|
+
* `filename` Name of file (e.g. *zorp.html* from *foo/bar/zorp.html*)
|
|
96
|
+
* `extname` File extension (e.g. *.html* from *foo/bar/zorp.html*)
|
|
97
|
+
* `src_path` Path with the original filename (e.g. *foo/index.md.liquid*)
|
|
98
|
+
|
|
99
|
+
### files
|
|
100
|
+
|
|
101
|
+
Any array of all files that will be written `dist/`. Same properties as `page`.
|
|
102
|
+
|
|
103
|
+
## Liquid filters
|
|
104
|
+
|
|
105
|
+
### relative_to
|
|
106
|
+
|
|
107
|
+
Modifies a path to be relative to another path. Useful in layouts and template that need to refer to another file.
|
|
108
|
+
|
|
109
|
+
```html
|
|
110
|
+
<script src="{{ "assets/main.js" | relative_to: page.path }}"</script>
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
### match
|
|
114
|
+
|
|
115
|
+
Returns true if the string matches the regex.
|
|
116
|
+
|
|
117
|
+
```liquid
|
|
118
|
+
{% assign is_asset = page.path | match: "\.(css|js|jpe?g)$"
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
## Liquid tags
|
|
122
|
+
|
|
123
|
+
### highlight
|
|
124
|
+
|
|
125
|
+
Converts the given code into something useable by [Highlight.js](https://highlightjs.org/).
|
|
126
|
+
|
|
127
|
+
```liquid
|
|
128
|
+
{% highlight ruby %}
|
|
129
|
+
puts "Yass!"
|
|
130
|
+
{% endhighlight %}
|
|
131
|
+
```
|
|
132
|
+
|
|
133
|
+
Hightlight.js CSS and JS files with common languages are included by default with `yass init`. [Download](https://highlightjs.org/download) your own versions if you want different languages or themes.
|
|
134
|
+
|
|
135
|
+
## Legal
|
|
44
136
|
|
|
45
137
|
MIT License. See LICENSE for details.
|
|
46
138
|
|
data/bin/yass
CHANGED
|
@@ -14,6 +14,10 @@ when :init
|
|
|
14
14
|
config = Yass::CLI::Helpers.get_opts!
|
|
15
15
|
retval = Yass::CLI::Runner.init(config, argv: ARGV)
|
|
16
16
|
exit retval
|
|
17
|
+
when :watch
|
|
18
|
+
config = Yass::CLI::Helpers.get_opts!
|
|
19
|
+
retval = Yass::CLI::Runner.watch(config, argv: ARGV)
|
|
20
|
+
exit retval
|
|
17
21
|
else
|
|
18
22
|
Yass::CLI::Helpers.help!
|
|
19
23
|
end
|
data/lib/yass/cli/helpers.rb
CHANGED
data/lib/yass/cli/runner.rb
CHANGED
|
@@ -3,7 +3,7 @@ require 'fileutils'
|
|
|
3
3
|
module Yass
|
|
4
4
|
module CLI
|
|
5
5
|
module Runner
|
|
6
|
-
INIT_DIR = Pathname.new(File.expand_path(File.join("..", "..", "..", "template"), __FILE__))
|
|
6
|
+
INIT_DIR = Pathname.new(File.expand_path(File.join("..", "..", "..", "..", "site-template"), __FILE__))
|
|
7
7
|
|
|
8
8
|
def self.build(config, argv:)
|
|
9
9
|
args = Helpers.get_args!(argv, max: 1)
|
|
@@ -33,6 +33,19 @@ module Yass
|
|
|
33
33
|
config.stderr.puts "#{e.class.name}: #{e.message}"
|
|
34
34
|
return 1
|
|
35
35
|
end
|
|
36
|
+
|
|
37
|
+
def self.watch(config, argv:)
|
|
38
|
+
config.stdout.puts "Watching for changes..."
|
|
39
|
+
watcher = Filewatcher.new([config.src_dir, config.layout_dir, config.template_dir].map(&:to_s))
|
|
40
|
+
yield watcher if block_given?
|
|
41
|
+
watcher.watch do |changes|
|
|
42
|
+
files = changes.map { |f, _| Pathname.new(f).relative_path_from(config.root).to_s }
|
|
43
|
+
config.stdout.puts "Building #{files.join ", "}"
|
|
44
|
+
config.clear_cache!
|
|
45
|
+
Yass::CLI::Runner.build(config, argv: argv)
|
|
46
|
+
end
|
|
47
|
+
return 0
|
|
48
|
+
end
|
|
36
49
|
end
|
|
37
50
|
end
|
|
38
51
|
end
|
data/lib/yass/config.rb
CHANGED
|
@@ -5,6 +5,11 @@ module Yass
|
|
|
5
5
|
def template_dir = root.join templates
|
|
6
6
|
def layout_dir = root.join layouts
|
|
7
7
|
|
|
8
|
+
def clear_cache!
|
|
9
|
+
@sources = nil
|
|
10
|
+
@layout_cache = nil
|
|
11
|
+
end
|
|
12
|
+
|
|
8
13
|
def layout_cache
|
|
9
14
|
@layout_cache ||= Dir[layout_dir.join("*.liquid")].each_with_object({}) do |path, acc|
|
|
10
15
|
path = Pathname.new(path)
|
|
@@ -25,7 +30,7 @@ module Yass
|
|
|
25
30
|
env.error_mode = :strict
|
|
26
31
|
env.file_system = Liquid::LocalFileSystem.new(template_dir.to_s, "%s.liquid")
|
|
27
32
|
env.register_filter LiquidFilters
|
|
28
|
-
env.register_tag 'highlight',
|
|
33
|
+
env.register_tag 'highlight', LiquidTags::Highlight
|
|
29
34
|
end
|
|
30
35
|
end
|
|
31
36
|
end
|
data/lib/yass/liquid_filters.rb
CHANGED
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
module Yass
|
|
2
|
+
module LiquidTags
|
|
3
|
+
class Highlight < Liquid::Block
|
|
4
|
+
attr_reader :lang
|
|
5
|
+
|
|
6
|
+
def initialize(_tag_name, lang, _tokens)
|
|
7
|
+
super
|
|
8
|
+
@lang = lang.strip
|
|
9
|
+
end
|
|
10
|
+
|
|
11
|
+
def render(_context)
|
|
12
|
+
%(<pre><code class="language-#{lang}">#{super}</code></pre>)
|
|
13
|
+
end
|
|
14
|
+
end
|
|
15
|
+
end
|
|
16
|
+
end
|
data/lib/yass/liquid_template.rb
CHANGED
|
@@ -13,7 +13,7 @@ module Yass
|
|
|
13
13
|
end
|
|
14
14
|
|
|
15
15
|
def render(source)
|
|
16
|
-
vars = { "page" =>
|
|
16
|
+
vars = { "page" => file_attrs(source), "files" => files_attrs(source.config.sources) }
|
|
17
17
|
vars["content"] = yield if block_given?
|
|
18
18
|
content = @template.render(vars, { strict_variables: true, strict_filters: true })
|
|
19
19
|
if @template.errors.any?
|
|
@@ -25,25 +25,18 @@ module Yass
|
|
|
25
25
|
|
|
26
26
|
private
|
|
27
27
|
|
|
28
|
-
def
|
|
28
|
+
def file_attrs(source)
|
|
29
29
|
{
|
|
30
30
|
"title" => source.title,
|
|
31
31
|
"url" => source.url.to_s,
|
|
32
32
|
"path" => source.relative_path.dirname.join(source.rendered_filename).to_s,
|
|
33
|
+
"src_path" => source.relative_path.to_s,
|
|
34
|
+
"dirname" => source.relative_path.dirname.to_s,
|
|
35
|
+
"filename" => source.rendered_filename,
|
|
36
|
+
"extname" => source.rendered_filename[/\.[^.]+$/],
|
|
33
37
|
}
|
|
34
38
|
end
|
|
35
39
|
|
|
36
|
-
def files_attrs(sources)
|
|
37
|
-
sources.map do |source|
|
|
38
|
-
{
|
|
39
|
-
"url" => source.url.to_s,
|
|
40
|
-
"path" => source.relative_path.dirname.join(source.rendered_filename).to_s,
|
|
41
|
-
"dirname" => source.relative_path.dirname.to_s,
|
|
42
|
-
"filename" => source.rendered_filename,
|
|
43
|
-
"extname" => source.rendered_filename[/\.[^.]+$/],
|
|
44
|
-
"title" => source.title,
|
|
45
|
-
}
|
|
46
|
-
end
|
|
47
|
-
end
|
|
40
|
+
def files_attrs(sources) = sources.map { |s| file_attrs s }
|
|
48
41
|
end
|
|
49
42
|
end
|
data/lib/yass/source.rb
CHANGED
|
@@ -22,7 +22,7 @@ module Yass
|
|
|
22
22
|
fname.sub(/[_-]+/, " ").split(/ +/).map(&:capitalize).join(" ")
|
|
23
23
|
end
|
|
24
24
|
|
|
25
|
-
def dynamic? = !!(/\.(liquid|md)(
|
|
25
|
+
def dynamic? = !!(/\.(liquid|md)(\..+)?$/ =~ path.basename.to_s || layout)
|
|
26
26
|
|
|
27
27
|
def index? = rendered_filename == "index.html"
|
|
28
28
|
|
data/lib/yass/version.rb
CHANGED
data/lib/yass.rb
CHANGED
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
require 'pathname'
|
|
2
|
+
require 'filewatcher'
|
|
2
3
|
require 'kramdown'
|
|
3
4
|
require 'liquid'
|
|
4
5
|
|
|
@@ -7,7 +8,7 @@ module Yass
|
|
|
7
8
|
autoload :Config, 'yass/config'
|
|
8
9
|
autoload :Generator, 'yass/generator'
|
|
9
10
|
autoload :LiquidFilters, 'yass/liquid_filters'
|
|
10
|
-
autoload :
|
|
11
|
+
autoload :LiquidTags, 'yass/liquid_tags'
|
|
11
12
|
autoload :LiquidTemplate, 'yass/liquid_template'
|
|
12
13
|
autoload :Source, 'yass/source'
|
|
13
14
|
autoload :VERSION, 'yass/version'
|
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: yass
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.0
|
|
4
|
+
version: 0.1.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Jordan Hollinger
|
|
@@ -10,6 +10,20 @@ bindir: bin
|
|
|
10
10
|
cert_chain: []
|
|
11
11
|
date: 2025-05-08 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
|
+
- !ruby/object:Gem::Dependency
|
|
14
|
+
name: filewatcher
|
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
|
16
|
+
requirements:
|
|
17
|
+
- - "~>"
|
|
18
|
+
- !ruby/object:Gem::Version
|
|
19
|
+
version: '2.0'
|
|
20
|
+
type: :runtime
|
|
21
|
+
prerelease: false
|
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
23
|
+
requirements:
|
|
24
|
+
- - "~>"
|
|
25
|
+
- !ruby/object:Gem::Version
|
|
26
|
+
version: '2.0'
|
|
13
27
|
- !ruby/object:Gem::Dependency
|
|
14
28
|
name: kramdown
|
|
15
29
|
requirement: !ruby/object:Gem::Requirement
|
|
@@ -47,12 +61,6 @@ extra_rdoc_files: []
|
|
|
47
61
|
files:
|
|
48
62
|
- README.md
|
|
49
63
|
- bin/yass
|
|
50
|
-
- lib/template/layouts/default.html.liquid
|
|
51
|
-
- lib/template/site/assets/highlight-default.css
|
|
52
|
-
- lib/template/site/assets/highlight.min.js
|
|
53
|
-
- lib/template/site/index.default.html.liquid
|
|
54
|
-
- lib/template/templates/css_links.liquid
|
|
55
|
-
- lib/template/templates/js_scripts.liquid
|
|
56
64
|
- lib/yass.rb
|
|
57
65
|
- lib/yass/cli.rb
|
|
58
66
|
- lib/yass/cli/helpers.rb
|
|
@@ -60,10 +68,16 @@ files:
|
|
|
60
68
|
- lib/yass/config.rb
|
|
61
69
|
- lib/yass/generator.rb
|
|
62
70
|
- lib/yass/liquid_filters.rb
|
|
63
|
-
- lib/yass/
|
|
71
|
+
- lib/yass/liquid_tags.rb
|
|
64
72
|
- lib/yass/liquid_template.rb
|
|
65
73
|
- lib/yass/source.rb
|
|
66
74
|
- lib/yass/version.rb
|
|
75
|
+
- site-template/layouts/default.html.liquid
|
|
76
|
+
- site-template/site/assets/highlight-default.css
|
|
77
|
+
- site-template/site/assets/highlight.min.js
|
|
78
|
+
- site-template/site/index.default.html.liquid
|
|
79
|
+
- site-template/templates/css_links.liquid
|
|
80
|
+
- site-template/templates/js_scripts.liquid
|
|
67
81
|
homepage: https://github.com/jhollinger/yass
|
|
68
82
|
licenses:
|
|
69
83
|
- MIT
|
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
module Yass
|
|
2
|
-
class LiquidHighlightTag < Liquid::Block
|
|
3
|
-
attr_reader :lang
|
|
4
|
-
|
|
5
|
-
def initialize(_tag_name, lang, _tokens)
|
|
6
|
-
super
|
|
7
|
-
@lang = lang.strip
|
|
8
|
-
end
|
|
9
|
-
|
|
10
|
-
def render(_context)
|
|
11
|
-
%(<pre><code class="language-#{lang}">#{super}</code></pre>)
|
|
12
|
-
end
|
|
13
|
-
end
|
|
14
|
-
end
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|