qsgen3/site.conf.example
Stig-Ørjan Smelror ed7ed0ee18 feat: Add comprehensive minification system for HTML, CSS, and XML files
- Implement _minify_html(), _minify_css(), and _minify_xml() functions
- Add _minify_file() and _minify_output_directory() orchestration functions
- Add build_options_minify_html, build_options_minify_css, build_options_minify_xml config options
- Integrate minification into main workflow after content generation
- Provide detailed logging with file size reduction statistics
- Achieve 25-35% HTML, 5-15% CSS, and 5-10% XML size reductions
- Update site.conf.example with documented minification options
- Non-destructive implementation using temporary files with error handling
2025-05-31 01:31:44 +02:00

45 lines
3.6 KiB
Plaintext

# Example Site Configuration for qsgen3
# Copy this file to 'site.conf' in your project root and customize it.
# --- Site Metadata ---
# These settings define general information about your site.
site_name="My Example Site" # The main title of your website, used in page titles, headers, and RSS feed.
site_tagline="An example site generated by qsgen3" # A short description or subtitle for your site, often used in meta tags or headers.
site_url="http://localhost:8000" # Full base URL of your site (e.g., https://www.example.com). Essential for generating correct absolute links in RSS feeds, sitemaps, etc.
site_theme="minimal" # Name of the theme directory located under your project's 'themes/' folder (e.g., "minimal", "custom-theme").
site_theme_css_file="css/minimaltemplate-v1.css" # Path to the theme's main CSS file, relative to the THEME'S 'static/' directory (e.g., "css/style.css", "main.css").
# --- Paths ---
# Define the directory structure for your project.
# Paths are relative to your project's root directory (where site.conf is) unless an absolute path (starting with '/') is provided.
paths_content_dir="content" # Directory containing your Markdown content files (posts, pages).
paths_output_dir="output" # Directory where the generated static website will be written.
paths_layouts_dir="layouts" # Directory containing global HTML layout templates (e.g., post.html, page.html, index.html) used by Pandoc.
paths_static_dir="static" # Project's root directory for global static assets (images, CSS, JS) that are not theme-specific.
# These are copied to the output's static folder. Theme static files take precedence in case of name conflicts.
# --- Build Options ---
# Control various aspects of the site generation process.
build_options_generate_rss=true # Generate an RSS feed for your posts. Set to 'true' to enable, 'false' to disable.
# The feed will be available at /rss.xml.
build_options_generate_sitemap=true # Generate a sitemap.xml. Set to 'true' to enable, 'false' to disable.
# Note: Sitemap generation is a basic implementation. The sitemap will be at /sitemap.xml.
build_options_process_drafts=false # Process draft posts/pages. Set to 'true' to include content marked as 'draft: true' in its frontmatter,
# 'false' to exclude them from the build.
# --- Minification Options ---
# Control file minification to reduce file sizes and improve site loading performance.
build_options_minify_html=false # Minify HTML files by removing comments, extra whitespace, and empty lines.
# Set to 'true' to enable HTML minification, 'false' to disable.
# Typical size reduction: 25-35%.
build_options_minify_css=false # Minify CSS files by removing comments, whitespace, and optimizing syntax.
# Set to 'true' to enable CSS minification, 'false' to disable.
# Typical size reduction: 5-15%.
build_options_minify_xml=false # Minify XML files (RSS feeds, sitemaps) by removing comments and extra whitespace.
# Set to 'true' to enable XML minification, 'false' to disable.
# Typical size reduction: 5-10%.