💾 Archived View for gemini.hyperlinkyourheart.com › gemicandocs › pages › settings.gmi captured on 2022-04-28 at 17:19:35. Gemini links have been rewritten to link to archived content
⬅️ Previous capture (2021-11-30)
-=-=-=-=-=-=-
Gemican is configurable thanks to a settings file you can pass to the command line:
gemican content -s path/to/your/gemicanconf.py
If you used the `gemican-quickstart` command, your primary settings file will be named `gemicanconf.py` by default.
You can also specify extra settings via `-e` / `--extra-settings` option flags, which will override default settings as well as any defined within settings files:
gemican content -e DELETE_OUTPUT_DIRECTORY=true
When experimenting with different settings (especially the metadata ones) caching may interfere and the changes may not be visible. In such cases disable caching with `LOAD_CONTENT_CACHE = False` or use the `--ignore-cache` command-line switch.
Settings are configured in the form of a Python module (a file). There is an example settings file[1] available for reference.
To see a list of current settings in your environment, including both default and any customized values, run the following command (append one or more specific setting names as arguments to see values for those settings only):
gemican --print-settings
All the setting identifiers must be set in all-caps, otherwise they will not be processed. Setting values that are numbers (5, 20, etc.), booleans (True, False, None, etc.), dictionaries, or tuples should *not* be enclosed in quotation marks. All other values (i.e., strings) *must* be enclosed in quotation marks.
Unless otherwise specified, settings that refer to paths can be either absolute or relative to the configuration file. The settings you define in the configuration file will be passed to the templates, which allows you to use your settings to add site-wide content.
Here is a list of settings for Gemican:
When you don't specify a category in your post metadata, set this setting to `True`, and organize your articles in subfolders, the subfolder will become the category of your post. If set to `False`, `DEFAULT_CATEGORY` will be used as a fallback.
The default category to fall back on.
Whether to display pages on the menu of the template. Templates may or may not honor this setting.
Whether to display categories on the menu of the template. Templates may or not honor this setting.
Delete the output directory, and **all** of its contents, before generating new files. This can be useful in preventing older, unnecessary files from persisting in your output. However, **this is a destructive setting and should be handled with extreme care.**
A list of filenames that should be retained and not deleted from the output directory. One use case would be the preservation of version control data.
Example:
OUTPUT_RETENTION = [".hg", ".git", ".bzr"]
A dictionary of custom Jinja2 environment variables you want to use. This also includes a list of extensions you may want to include. See Jinja Environment documentation[2].
A dictionary of custom Jinja2 filters you want to use. The dictionary should map the filtername to the filter function.
Example:
import sys
sys.path.append('to/your/path')
from custom_filter import urlencode_filter
JINJA_FILTERS = {'urlencode': urlencode_filter}
See: Jinja custom filters documentation[3].
A dictionary of custom objects to map into the Jinja2 global environment namespace. The dictionary should map the global name to the global variable/function. See: Jinja global namespace documentation[4].
A dictionary of custom Jinja2 tests you want to use. The dictionary should map test names to test functions. See: Jinja custom tests documentation[5].
A list of tuples containing the logging level (up to `warning`) and the message to be ignored.
Example:
LOG_FILTER = [(logging.WARN, 'TAG_SAVE_AS is set to False')]
A dictionary of file extensions / Reader classes for Gemican to process or ignore.
For example, to avoid processing .md files, set:
READERS = {'md': None}
To add a custom reader for the `foo` extension, set:
READERS = {'foo': FooReader}
A list of glob patterns. Files and directories matching any of these patterns will be ignored by the processor. For example, the default `['.#*']` will ignore emacs lock files, and `['__pycache__']` would ignore Python 3's bytecode caches.
Extra configuration settings for the Markdown processor. Refer to the md2gemini documentation's In Python[6] section for a complete list of supported options.
Defaults to:
MARKDOWN = {
'strip_html': True,
'plain': False,
'code_tag': "",
'links': 'paragraph',
}
Note: The dictionary defined in your settings file will replace this default one.
Where to output the generated files. This should correspond to your web server's virtual host root directory.
Path to content directory to be processed by Gemican. If undefined, and content path is not specified via an argument to the `gemican` command, Gemican will use the current working directory.
A list of directories and files to look at for pages, relative to `PATH`.
A list of directories to exclude when looking for pages in addition to `ARTICLE_PATHS`.
A list of directories and files to look at for articles, relative to `PATH`.
A list of directories to exclude when looking for articles in addition to `PAGE_PATHS`.
Set to True if you want to copy the articles and pages in their original format (e.g. Markdown or reStructuredText) to the specified `OUTPUT_PATH`.
Controls the extension that will be used by the SourcesGenerator. Defaults to `.text`. If not a valid string the default value will be used.
The list of plugins to load. See plugins[7].
A list of directories where to look for plugins. See plugins[8].
Your site name
Base URL of your web site. Not defined by default, so it is best to specify your SITEURL; if you do not, feeds will not be generated with properly-formed URLs. This setting should begin with gemini://. Then append your domain, with no trailing slash at the end. Example: `SITEURL = 'gemini://example.com'`
A list of directories (relative to `PATH`) in which to look for static files. Such files will be copied to the output directory without modification. Articles, pages, and other content source files will normally be skipped, so it is safe for a directory to appear both here and in `PAGE_PATHS` or `ARTICLE_PATHS`. Gemican's default settings include the "images" directory here.
A list of directories to exclude when looking for static files.
If set to False, content source files will not be skipped when copying files found in `STATIC_PATHS`. It has no effect unless `STATIC_PATHS` contains a directory that is also in `ARTICLE_PATHS` or `PAGE_PATHS`. If you are trying to publish your site's source files, consider using the `OUTPUT_SOURCES` setting instead.
Create links instead of copying files. If the content and output directories are on the same device, then create hard links. Falls back to symbolic links if the output directory is on a different filesystem. If symlinks are created, don't forget to add the `-L` or `--copy-links` option to rsync when uploading your site.
If set to `True`, and `STATIC_CREATE_LINKS` is `False`, compare mtimes of content and output files, and only copy content files that are newer than existing output files.
When creating a short summary of an article, this will be the default length (measured in words) of the text created. This only applies if your content does not otherwise specify a summary. Setting to `None` will cause the summary to be a copy of the original content.
When creating a short summary of an article and the result was truncated to match the required word length, this will be used as the truncation suffix.
If disabled, content with dates in the future will get a default status of `draft`. See `Reading only modified content` below for caveats.
Default:
'[{|](?P<what>.*?)[|}]'
Regular expression that is used to parse internal links. Default syntax when linking to internal files, tags, etc., is to enclose the identifier, say `filename`, in `{}` or `||`. Identifier between `{` and `}` goes into the `what` capturing group.
If `True`, saves content in caches. See `Reading only modified content` below for details about caching.
If set to `'reader'`, save only the raw content and metadata returned by readers. If set to `'generator'`, save processed content objects.
Directory in which to store cache files.
If `True`, use gzip to (de)compress the cache files.
Controls how files are checked for modifications.
If `True`, load unmodified content from caches.
If this list is not empty, **only** output files with their paths in this list are written. Paths should be either absolute or relative to the current Gemican working directory. For possible use cases see `Writing only selected content` below.
A list of metadata fields containing Gemtext/Markdown content. This allows multi-line metadata. I tis up to templates whether to use the metadata in the provided form.
The TCP port to serve content from the output folder via gemini when gemican is run with --listen
The IP to which to bind the gemini server. This setting currently has no effect, but may in the future.
The path to the SSL private key.
The path to the SSL certificate.
The first thing to understand is that there are currently two supported methods for URL formation: *relative* and *absolute*. Relative URLs are useful when testing locally, and absolute URLs are reliable and most useful when publishing. One method of supporting both is to have one Gemican configuration file for local development and another for publishing. To see an example of this type of setup, use the `gemican-quickstart` script as described in the Installation[9] section, which will produce two separate configuration files for local development and publishing, respectively.
You can customize the URLs and locations where files will be saved. The `*_URL` and `*_SAVE_AS` variables use Python's format strings. These variables allow you to place your articles in a location such as `{slug}/index.gmi` and link to them as `{slug}` for clean URLs (see example below). These settings give you the flexibility to place your articles and pages anywhere you want.
Note:
If a `*_SAVE_AS` setting contains a parent directory that doesn't match the parent directory inside the corresponding `*_URL` setting, this may cause Gemican to generate unexpected URLs in a few cases, such as when using the `{attach}` syntax.
If you don't want that flexibility and instead prefer that your generated output paths mirror your source content's filesystem path hierarchy, try the following settings:
PATH_METADATA = '(?P<path_no_ext>.*)\..*'
ARTICLE_URL = ARTICLE_SAVE_AS = PAGE_URL = PAGE_SAVE_AS = '{path_no_ext}.gmi'
Otherwise, you can use a variety of file metadata attributes within URL-related settings:
Example usage:
ARTICLE_URL = 'posts/{date:%Y}/{date:%b}/{date:%d}/{slug}/'
ARTICLE_SAVE_AS = 'posts/{date:%Y}/{date:%b}/{date:%d}/{slug}/index.gmi'
PAGE_URL = 'pages/{slug}/'
PAGE_SAVE_AS = 'pages/{slug}/index.gmi'
This would save your articles into something like `/posts/2011/Aug/07/sample-post/index.gmi`, save your pages into `/pages/about/index.gmi`, and render them available at URLs of `/posts/2011/Aug/07/sample-post/` and `/pages/about/`, respectively.
Note:
If you specify a `datetime` directive, it will be substituted using the input files' date metadata attribute. If the date is not specified for a particular file, Gemican will rely on the file's `mtime` timestamp. Check the Python datetime documentation[10] for more information.
Defines whether Gemican should use document-relative URLs or not. Only set this to `True` when developing/testing and only if you fully understand the effect it can have on links/feeds.
The URL to refer to an article.
The place where we will save an article.
The URL to refer to an article which doesn't use the default language.
The place where we will save an article which doesn't use the default language.
The URL to refer to an article draft.
The place where we will save an article draft.
The URL to refer to an article draft which doesn't use the default language.
The place where we will save an article draft which doesn't use the default language.
The URL we will use to link to a page.
The location we will save the page. This value has to be the same as PAGE_URL or you need to use a rewrite in your server config.
The URL we will use to link to a page which doesn't use the default language.
The location we will save the page which doesn't use the default language.
The URL used to link to a page draft.
The actual location a page draft is saved at.
The URL used to link to a page draft which doesn't use the default language.
The actual location a page draft which doesn't use the default language is saved at.
The URL to use for an author.
The location to save an author.
The URL to use for a category.
The location to save a category.
The URL to use for a tag.
The location to save the tag page.
Note:
If you do not want one or mor