kekePower/qsgen3
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: Enhance explanations in site.conf.example

Browse Source 
Updated site.conf.example to provide clearer and more detailed descriptions for each configuration variable, improving usability for new users.
This commit is contained in:
Stig-Ørjan Smelror 2025-05-31 00:14:51 +02:00
parent 1b8898ae2e
commit f5d6d0eb49
1 changed files with 21 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
site.conf.example
View File

@ -2,26 +2,29 @@
# Copy this file to 'site.conf' in your project root and customize it.
# --- Site Metadata ---
site_name="My Example Site"
site_tagline="An example site generated by qsgen3"
site_url="http://localhost:8000" # Or your actual production URL
site_theme="minimal" # Specifies the theme to use (e.g., minimal, default)
site_theme_css_file="css/minimaltemplate-v1.css" # Path to main CSS file, relative to THEME'S static/ directory
# 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 (relative to project root) ---
paths_content_dir="content"
paths_output_dir="output"
paths_layouts_dir="layouts"
paths_static_dir="static"
# --- 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 ---
# Generate an RSS feed (true/false)
build_options_generate_rss=true
# 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.
# Generate a sitemap.xml (true/false)
# Note: sitemap generation is not fully implemented in qsgen3 yet,
# but the configuration option is reserved.
build_options_generate_sitemap=true
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.
# Process draft posts/pages (true/false)
build_options_process_drafts=false
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.