1. blogcfile(5)
  2. blogc Manual
  3. blogcfile(5)

NAME

blogcfile - blogc-make's configuration file

DESCRIPTION

blogcfile is the configuration file for blogc-make(1), that is a simple build tool for blogc(1). It is an INI-style file, with some predefined sections, that will provide the data required by blogc-make(1) rules to build websites.

blogcfile must be valid UTF-8.

OPTIONS

Global variables

The [global] section contains all the blogc(1) variables that should be passed to all blogc(1) calls.

The following variables are required and should be always provided:

AUTHOR_NAME

The name of the website main author.

AUTHOR_EMAIL

The email of the website main author.

BASE_DOMAIN

The base domain of the website.

SITE_TITLE

The website title.

SITE_TAGLINE

The website tagline.

Settings

blogc-make(1) relies on a predefined set of rules to build the websites, however these rules can be customized with the following settings, from the [settings] section:

Posts listing

The [posts] section is a listing of the posts that will be included in the website. They should be listed without the post prefix and without the extension, only the "slugs" should be used. For example, with default settings, if the source of the post is content/post/foo.txt, the line added to the [posts] section is foo.

All the posts are relative to the post_prefix in the root of the website.

Pages listing

The [pages] section is a listing of the pages that will be included in the website. They should be listed without the page prefix and without the extension, only the "slugs" should be used. For example, with default settings, if the source of the page is content/foo.txt, the line added to the [pages] section is foo.

All the pages are relative to the root of the website.

Tags listing

The [tags] section is a listing of the tags that should be listed in the website. blogc-make(1) will generate post listing indexes and Atom feeds for each tag listed in the section.

The tags will be also provided to blogc as a MAKE_TAGS variable, that is a space-separated list of the tags, useful to generate tag clouds using the foreach template iterator. See blogc-template(7).

Copy listing

The [copy] section is a listing of the files that should be copied to the output directory.

All the files are relative to the blogcfile, and their directory structure will be built inside the output directory.

EXAMPLE

[global]
AUTHOR_NAME = Author
AUTHOR_EMAIL = author@example.org
SITE_TITLE = Site Title
SITE_TAGLINE = Site Tagline
BASE_DOMAIN = http://example.org

[settings]
locale = en_US.utf8

[posts]
post1
post2

[pages]
about

[tags]
tag1
tag2

[copy]
assets/custom.css

BUGS

Please report any issues to: https://github.com/blogc/blogc

AUTHOR

Rafael G. Martins <rafael@rafaelmartins.eng.br>

SEE ALSO

blogc(1), blogc-make(1), blogc-template(7) strftime(3)

  1. Rafael G. Martins
  2. July 2018
  3. blogcfile(5)