Configuration

Configure LSSG via TOML comments at the start of markdown files. Resources (CSS, JavaScript, images, fonts, videos) are automatically discovered through links and copied to the build directory.

Resource Locations

Resources can be:

• Referenced directly in markdown: ![Image](./images/photo.jpg)
• Imported in CSS files: @import url('fonts/custom.css');
• Linked in HTML: <script src="./script.js"></script>
• Used as custom elements: <carousel>![](image.jpg)</carousel>

All discovered resources are automatically included in the build output without manual configuration. Glob) patterns are supported too, so you can reference sets of files with patterns like images/*, assets/**/*.js, or fonts/*.{woff,woff2}.

Configuration Options

Configuration Inheritance

Inheritance means configuration settings automatically flow down from parent pages to their children based on your site's directory structure.

How It Works

Configuration options set in a parent page (e.g., docs/index.md) automatically apply to all child pages in subdirectories (e.g., docs/tutorials/tutorial1.md) without needing to repeat them.

Example directory structure:

docs/
  index.md          ← parent (sets language="de", nav.kind="sidemenu")
  tutorials/
    tutorial1.md    ← child (inherits both settings)
    tutorial2.md    ← child (inherits both settings)

Key Behaviors

• Automatic propagation: Options marked "Yes" in the "Inherited" column propagate to all descendant pages
• Override capability: Child pages can specify their own values to replace inherited ones
• Break the chain: Use root = true in a page to stop inheriting from parents and start fresh

Practical Example

Parent page sets site-wide defaults:

<!-- docs/index.md -->
<!--
language = "nl"
[nav]
kind = "sidemenu"
[footer]
watermark = true
-->

Child page inherits everything:

<!-- docs/tutorials/tutorial1.md -->
<!-- Automatically has language="de", nav.kind="sidemenu", footer.watermark=true -->
# Tutorial 1

Child page overrides specific values:

<!-- docs/tutorials/tutorial2.md -->
<!--
language = "en"  # Override: use English instead of inherited German
-->
# Tutorial 2
<!-- Still inherits nav.kind="sidemenu" and footer.watermark=true -->

This inheritance system eliminates repetition and makes site-wide changes easy—just update the parent configuration.

Example

<!--
title = "My Blog Post"
language = "en"
section_links = true

[meta]
description = "A great post about Rust"
author = "Your Name"

[nav]
kind = "sidemenu"
include_root = true
name_map = { home = "Home Page", post = "Post Posts" }

[post]
created_on = "2025-01-03"
tags = ["rust", "tutorial"]
summary = "Learn about static site generators"

[media]
optimize_images = true
image_quality = 85
convert_to_webp = true

[footer]
items = ['<a href="/about">About</a>', '<a href="/contact">Contact</a>']
watermark = true
-->

# Page Content