MahmoudEmad/herolib
1
0
Fork 0
Code Issues 55 Pull Requests 1 Actions Packages Projects Releases 26 Wiki Activity

Merge branch 'development' of github.com:incubaid/herolib into development

Browse Source
This commit is contained in:
despiegk
2025-10-19 16:28:37 +02:00
parent 1a76c31865 f477fe46b3
commit b538540cd4
1 changed files with 7 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
lib/web/site/readme.md
View File

@@ -5,6 +5,7 @@ The Site module provides a structured way to define website configurations, navi
## Purpose ## Purpose
The Site module allows you to: The Site module allows you to:
- Define website structure and configuration in a declarative way using HeroScript - Define website structure and configuration in a declarative way using HeroScript
- Organize pages into sections/categories - Organize pages into sections/categories
- Configure navigation menus and footers - Configure navigation menus and footers
@@ -101,7 +102,7 @@ println(mysite)
When you don't need categories, pages are added sequentially. The collection only needs to be specified once, then it's reused for subsequent pages. When you don't need categories, pages are added sequentially. The collection only needs to be specified once, then it's reused for subsequent pages.
```heroscript ```heroscript
!!site.page src: "tech:introduction" !!site.page src: "mycelium_tech:introduction"
description: "Introduction to ThreeFold Technology" description: "Introduction to ThreeFold Technology"
slug: "/" slug: "/"
@@ -119,6 +120,7 @@ When you don't need categories, pages are added sequentially. The collection onl
``` ```
**Key Points:** **Key Points:**
- First page specifies collection as `tech:introduction` (collection:page_name format) - First page specifies collection as `tech:introduction` (collection:page_name format)
- Subsequent pages only need the page name (e.g., `vision`) - the `tech` collection is reused - Subsequent pages only need the page name (e.g., `vision`) - the `tech` collection is reused
- If `title` is not specified, it will be extracted from the markdown file itself - If `title` is not specified, it will be extracted from the markdown file itself
@@ -145,6 +147,7 @@ Categories (sections) help organize pages into logical groups with their own nav
``` ```
**Key Points:** **Key Points:**
- `!!site.page_category` creates a new section/category - `!!site.page_category` creates a new section/category
- `name` is the internal identifier (snake_case) - `name` is the internal identifier (snake_case)
- `label` is the display name (automatically derived from `name` if not specified) - `label` is the display name (automatically derived from `name` if not specified)
@@ -160,7 +163,7 @@ Categories (sections) help organize pages into logical groups with their own nav
label: "System Components" label: "System Components"
position: 100 position: 100
!!site.page src: "tech:mycelium" !!site.page src: "mycelium_tech:mycelium"
title: "Mycelium Network" title: "Mycelium Network"
description: "Peer-to-peer overlay network" description: "Peer-to-peer overlay network"
slug: "mycelium-network" slug: "mycelium-network"
@@ -175,6 +178,7 @@ Categories (sections) help organize pages into logical groups with their own nav
``` ```
**Available Page Parameters:** **Available Page Parameters:**
- `src`: Source reference as `collection:page_name` (required for first page in collection) - `src`: Source reference as `collection:page_name` (required for first page in collection)
- `title`: Page title (optional, extracted from markdown if not provided) - `title`: Page title (optional, extracted from markdown if not provided)
- `description`: Page description for metadata - `description`: Page description for metadata
@@ -321,4 +325,4 @@ pub mut:
See `examples/web/site/site_example.vsh` for a complete working example. See `examples/web/site/site_example.vsh` for a complete working example.
For a real-world example, check: https://git.ourworld.tf/tfgrid/docs_tfgrid4/src/branch/main/ebooks/tech For a real-world example, check: <https://git.ourworld.tf/tfgrid/docs_tfgrid4/src/branch/main/ebooks/tech>