doc: remove warning about required zig version

Accessing resources which are not available, the invalid page will be
rendered instead. The original attempt for access will be logged.

.gitea/workflows/release.yaml

@@ -15,9 +15,9 @@ jobs:
       - name: Checkout repository
         uses: actions/checkout@v4
       - name: Setup zig installation
-        uses: mlugg/setup-zig@v2
+        uses: https://codeberg.org/mlugg/setup-zig@v2
         with:
-          version: master
+          version: latest
       - name: Run tests
         run: zig build --release=fast
       - name: Release build artifacts

.gitea/workflows/test.yaml

@@ -14,9 +14,9 @@ jobs:
       - name: Checkout repository
         uses: actions/checkout@v4
       - name: Setup zig installation
-        uses: mlugg/setup-zig@v2
+        uses: https://codeberg.org/mlugg/setup-zig@v2
         with:
-          version: master
+          version: latest
       - name: Lint check
         run: zig fmt --check .
       - name: Spell checking

README.md

@@ -4,9 +4,6 @@ This is my terminal based website. It is served as a tui application via ssh and
 
 It contains information about me and my projects as well as blog entries about something I feel like writing something about.
 
-> [!caution]
-> Only builds using the zig master version are tested to work.
-
 ## zterm
 
 This tui application also serves as an example implementation of the [zterm](https://gitea.yves-biener.de/yves-biener/zterm) library.

build.zig.zon

@@ -1,17 +1,17 @@
 .{
     .name = .tui_website,
     // This is a [Semantic Version](https://semver.org/).
-    .version = "0.0.3",
+    .version = "0.0.4",
     .fingerprint = 0x93d98a4d9d000e9c, // Changing this has security and trust implications.
     .minimum_zig_version = "0.16.0-dev.463+f624191f9",
     .dependencies = .{
         .zterm = .{
-            .url = "git+https://gitea.yves-biener.de/yves-biener/zterm#ad32e46bc9fd6d1d9b7a3615979a3b80877c9300",
+            .url = "git+https://gitea.yves-biener.de/yves-biener/zterm#4874252e8c3a5d645ac2c37bbfd0e669964912fc",
-            .hash = "zterm-0.3.0-1xmmEO8PHABP4tE6BnEZllJTh6Hpza_5C9wS8s2vjwou",
+            .hash = "zterm-0.3.0-1xmmEH82HABfsn5imAK8lw93LevIaqNV10g6xfkNj_OT",
         },
         .zlog = .{
-            .url = "git+https://gitea.yves-biener.de/yves-biener/zlog#f43034cea9a0863e618c3d0a43706ce38c8791cf",
+            .url = "git+https://gitea.yves-biener.de/yves-biener/zlog#40ced30a574118cd76202c07dc4b2291c3321d3a",
-            .hash = "zlog-0.16.0-6JSlRx1JAADasbK5FS6Qaf0Iq1SCQaH5VZRxT2SRE2xs",
+            .hash = "zlog-0.16.0-6JSlR-BIAAAZ4fSbV54zbZZ9hnZSeOPnnFtiVjmIy3ID",
         },
     },
     .paths = .{

src/content.zig

@@ -21,25 +21,13 @@ pub fn Content(App: type) type {
             };
         }
 
-        fn minSize(ctx: *anyopaque, size: zterm.Point) zterm.Point {
+        fn minSize(ctx: *anyopaque, _: *const App.Model, size: zterm.Point) zterm.Point {
             const this: *const @This() = @ptrCast(@alignCast(ctx));
-            const text = this.document.content;
+            _ = this;
-            var index: usize = 0;
+            //const text = this.document.content;
-            var new_size: zterm.Point = .{ .x = size.x };
+            //var index: usize = 0;
+            const new_size: zterm.Point = .{ .x = size.x };
 
-            for (0..text.len) |_| rows: {
-                for (0..size.x - 1) |_| { // assume that there is one cell reserved for the scrollbar
-                    if (index == text.len) break :rows;
-                    const cp = text[index];
-                    index += 1;
-
-                    switch (cp) {
-                        '\n' => break,
-                        else => {},
-                    }
-                }
-                new_size.y += 1;
-            }
             return new_size;
         }
 
@@ -52,15 +40,21 @@ pub fn Content(App: type) type {
                     model.page = .about;
 
                     model.document.deinit(this.allocator);
-                    model.document = .init(try std.fs.cwd().readFileAlloc("./doc/about.md", this.allocator, .unlimited));
+                    model.document = .init(try std.fs.cwd().readFileAlloc(this.allocator, "./doc/about.md", std.math.maxInt(usize)));
                     this.document = &model.document;
                 },
                 .blog => |path| {
                     model.page.deinit(this.allocator);
+                    model.document.deinit(this.allocator);
+                    errdefer {
+                        if (path) |p| this.allocator.free(p);
+                        model.document = .invalidPage;
+                        model.page = .{ .blog = null };
+                    }
+
+                    model.document = .init(try std.fs.cwd().readFileAlloc(this.allocator, if (path) |p| p else "./doc/blog.md", std.math.maxInt(usize)));
                     model.page = .{ .blog = path };
 
-                    model.document.deinit(this.allocator);
-                    model.document = .init(try std.fs.cwd().readFileAlloc(if (path) |p| p else "./doc/blog.md", this.allocator, .unlimited));
                     this.document = &model.document;
                 },
                 else => {},

src/main.zig

@@ -1,4 +1,11 @@
-// usage: tui_website <path>
+// TODO
+// - should the path containing the contents of the tui-website reside in the
+//   hardcode `./doc` directory or shall this become a compilation argument to
+//   allow for custom directory locations?
+
+// usage: tui_website <location>
+// <location>: partial path to the document without the file extension and the beginning `./doc` path
+//             ending `/` (as used from the web-world) are trimmed automatically
 pub fn main() !void {
     errdefer |err| log.err("Application Error: {any}", .{err});
 
@@ -13,9 +20,9 @@ pub fn main() !void {
     // skip own executable name
     _ = arg_it.skip();
 
-    var app: App = .init(.{
+    var app: App = .init(.{}, .{
         .page = .about,
-        .document = .init(try std.fs.cwd().readFileAlloc("./doc/about.md", allocator, .unlimited)),
+        .document = .init(try std.fs.cwd().readFileAlloc(allocator, "./doc/about.md", std.math.maxInt(usize))),
     });
     defer app.model.deinit(allocator);
 
@@ -31,7 +38,6 @@ pub fn main() !void {
     }, .{});
     defer container.deinit();
     var content_container: App.Container = undefined;
-    defer content_container.deinit();
 
     // header with navigation buttons and content's title
     {
@@ -106,7 +112,11 @@ pub fn main() !void {
         //   -> enforce a specific structure?
         // -> in case an invalid path is provided the 404 error page shall be shown
         // -> reporte an corresponding error! (such that I can see that in the log)
-        app.postEvent(.{ .blog = try allocator.dupe(u8, path) });
+        var blog = path[0..path.len];
+        blog = std.mem.trimStart(u8, blog, "./");
+        blog = std.mem.trimEnd(u8, blog, ".md");
+        blog = std.mem.trimEnd(u8, blog, "/");
+        app.postEvent(.{ .blog = try std.fmt.allocPrint(allocator, "./doc/{s}.md", .{blog}) });
     }
     arg_it.deinit();
 
@@ -127,10 +137,12 @@ pub fn main() !void {
             // pre event handling
             switch (event) {
                 .key => |key| {
-                    if (key.eql(.{ .cp = 'c', .mod = .{ .ctrl = true } })) app.quit();
+                    if (key.eql(.{ .cp = 'c', .mod = .{ .ctrl = true } }) or key.eql(.{ .cp = 'q' })) app.quit();
                     // test if the event handling is working correctly
                     if (key.eql(.{ .cp = zterm.input.Space })) app.postEvent(.{ .blog = allocator.dupe(u8, "./doc/test.md") catch unreachable });
                 },
+                .about => log.info(ResourceRequestFormat, .{"./doc/about.md"}),
+                .blog => |path| log.info(ResourceRequestFormat, .{if (path) |p| p else "./doc/blog.md"}),
                 .err => |err| log.err("Received {s} with message: {s}", .{ @errorName(err.err), err.msg }),
                 else => {},
             }
@@ -149,9 +161,8 @@ pub fn main() !void {
             }
         }
 
-        container.resize(try renderer.resize());
+        container.resize(&app.model, try renderer.resize());
-        container.reposition(.{});
+        container.reposition(&app.model, .{});
-
         try renderer.render(@TypeOf(container), &container, App.Model, &app.model);
         try renderer.flush();
     }
@@ -161,6 +172,8 @@ pub const panic = App.panic_handler;
 pub const std_options = zlog.std_options;
 const log = std.log.scoped(.default);
 
+const ResourceRequestFormat = "Requesting resource: `{s}`";
+
 const std = @import("std");
 const assert = std.debug.assert;
 const zlog = @import("zlog");

src/model.zig

@@ -33,6 +33,12 @@ pub const Document = struct {
         date,
     };
 
+    pub const invalidPage: @This() = .{
+        .title = "Page not found",
+        .content = "Requested page does not exist",
+        .ptr = undefined,
+    };
+
     pub fn init(content: []const u8) @This() {
         if (std.mem.startsWith(u8, content, "---\n")) {
             var document: @This() = .{ .ptr = content };