Config Reference

The config.yaml file is the central control panel for your website generation. Understanding its settings allows you to customize every aspect of the AI's output, from page structure to content tone. This guide provides a complete, field-by-field reference to help you modify your site with precision.

Overview#

The config.yaml file is the primary configuration source for AIGNE WebSmith. It uses the YAML format to store all the parameters the AI agent needs to generate your website. Every time you run a command like generate or update, WebSmith reads this file to understand your requirements.

• File Name: config.yaml
• Location: .aigne/web-smith/config.yaml (relative to your project's root directory)
• Format: YAML (UTF-8)

This file controls the website's purpose, target audience, content generation rules, page structure, multilingual support, and deployment settings.

Creating and Updating the Configuration#

The config.yaml file is created automatically when you first use WebSmith.

Creation:

You can create the file in two ways:

1. During the first generation: Running aigne web generate in a new project will launch an interactive wizard to create the config.yaml file before starting the generation process.
2. Separately: Running aigne web init launches the same wizard to create the configuration file without immediately generating the site.

aigne web init

Updating:

You can update your configuration using one of two methods:

1. Directly edit the file: Open .aigne/web-smith/config.yaml in a text editor and modify the fields.
2. Use the interactive wizard: Run aigne web init again. The wizard will load your existing settings and guide you through updating them.

Configuration Parameters#

The fields in config.yaml are organized into functional groups. The following sections provide a detailed explanation of each parameter.

Project Basics#

This group defines your project's identity, which is used for branding, SEO, and social media sharing.

Site Strategy#

These fields define the high-level strategy for the AI, influencing the site's purpose, content tone, and overall structure.

Languages#

Configure the primary language and any additional languages for translation.

Data Sources#

These fields specify the content and data that the AI agent will use as reference material.

Output & Deployment#

Configure output directories and deployment URLs.

Media & Display#

These settings control how media assets like images are handled.

System-Managed Fields#

These fields are typically managed by WebSmith and do not require manual editing.

Applying Changes#

Changes to the config.yaml file are not applied automatically. You must run the appropriate command to see your modifications take effect. The command needed depends on which field you changed.

Field(s)	Command to Apply Changes	Notes
pagePurpose, targetAudienceTypes, websiteScale, locale	aigne web clear && aigne web generate	These require a full regeneration to restructure the site correctly.
rules, media.minImageWidth, defaultDatasources	aigne web update	Updates existing content without a full regeneration.
sourcesPath	aigne web clear && aigne web generate or aigne web update	New sources are analyzed to improve content during updates.
translateLanguages	aigne web translate	Adds new language versions based on the updated list.
projectName, projectDesc, projectLogo, projectCover, appUrl	aigne web publish	These fields are primarily used during the publishing process.

Full Configuration Example#

The following is a complete config.yaml file from the AIGNE WebSmith project itself, demonstrating a real-world configuration.

projectName: AIGNE WebSmith
projectDesc: "AI-powered website generation tool built on the AIGNE Framework"
projectLogo: https://www.arcblock.io/content/uploads/2e5edbac4a7d5310c117d09601811c.png
projectId: pg4d0000-0000-4000-a000-000000000000
projectSlug: /
pagePurpose:
  - landingPage
targetAudienceTypes:
  - customers
websiteScale: singlePage
rules: |
  ### I. Core Messaging & Strategy: Foundational elements that define *what* you communicate to the user.
  1. Answer Critical Questions "Above the Fold": The very first screen a user sees must clearly and immediately answer:
    * What it is: A concise description of the product.
    * Who it's for: The specific target audience (e.g., solo founders, small teams).
    * Why it's different: Your unique value proposition (e.g., "open, composable, exportable code, agent workflow").
    * Primary Action: A single, clear Call to Action (CTA) that aligns with the user's main goal.
  2. Establish Credibility with Proof: Don't expect users to trust your claims. Show them proof early in the narrative.
    * Show, Don't Just Tell: The most powerful proof is a demo. Include a short (30-45s) silent video loop or a link to a real site built with the tool.
    * Use Social Proof: Before explaining "How it Works," insert tangible evidence like a customer logo, a compelling data point (e.g., "Used by 50+ teams"), or a strong user quote.
  3. Define a Clear Call to Action (CTA):
    * Align CTA with the Audience: The primary CTA should be the main action you want your target user to take (e.g., "Generate My Site").
    * Prioritize CTAs: Relegate secondary actions (like "See it on GitHub") to less prominent positions (tertiary buttons or footer links), especially for non-developer audiences.
    * Maintain a Persistent Mobile CTA: On mobile, a single primary CTA should always be visible.
locale: en

Summary#

Mastering the config.yaml file gives you full control over the website generation process. By carefully defining your project basics, site strategy, and data sources, you can guide the AI to produce a high-quality, relevant, and customized website.

For more hands-on guidance, see the following guides: