.. vim:   noexpandtab fileencoding=utf-8 nomodified   wrap textwidth=200 foldmethod=marker foldmarker={{{,}}} foldcolumn=4 ruler showcmd lcs=tab\:|- list

|logo| site_config.conf
################################################################################

:date: 2023.04.08 20:46:56
:tags: doc,chatGPT
:authors: Gilhad,chatGPT
:summary: doc: site_config.conf
:title: doc: site_config.conf

%HEADER%

Site Configuration
==============================

Introduction
------------

The site configuration file is an essential part of the My Site Builder static site generator. It allows you to customize various aspects of your website, such as its name, URL, and theme.

Configuration Options
----------------------

The following options are available in the `site_config.conf` file:

- `SITE_URL`: The URL of your website, including the protocol (e.g., `http://example.com`).

- `SITE_NAME`: The name of your website.

- `SITE_SUBTITLE`: The subtitle of your website.

- `COPYRIGHT`: The copyright notice for your website.

- `THEME_STATIC_DIR`: The directory where the static files for the theme are located.

- `CSS_FILE`: The name of the CSS file for your website.

- `FEED_ALL_RSS`: The path to the RSS feed file for your website.

Usage
-----

To use the `site_config.conf` file, simply create it in the root directory of your My Site Builder project, and modify the configuration options to suit your needs. Once you have done this, you can use the `get_config()` function in your Python code to access the configuration options.

Example Configuration
---------------------

Here is an example `site_config.conf` file:

.. code-block:: bash

   # config for site
   SITE_URL = http://example.com/
   SITE_NAME = My Site
   SITE_SUBTITLE = A wonderful website
   COPYRIGHT = Copyright © 2023 My Company
   THEME_STATIC_DIR = .theme
   CSS_FILE = style.css
   FEED_ALL_RSS = feeds/all.rss

   # Any other configuration options can be added here