Skip to content

Commit e913b14

Browse files
committed
doc
1 parent cdd6752 commit e913b14

1 file changed

Lines changed: 52 additions & 0 deletions

File tree

‎doc/configuration.rst‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,10 @@ The top-level structure of an FLM configuration file is:
7272
# Workflow-specific configuration
7373
...
7474
75+
# additional configuration possible: default format, default workflow,
76+
# template settings... (cf. below)
77+
78+
7579
You can also include top-level metadata such as a document title:
7680

7781
.. code-block:: yaml
@@ -135,6 +139,8 @@ priority than the ``flmconfig.yaml`` file:
135139

136140
---
137141
title: 'My FLM Document'
142+
author: 'John Doe'
143+
date: 'May 1, 2026'
138144
flm:
139145
parsing:
140146
dollar_inline_math_mode: true
@@ -371,6 +377,52 @@ Python module path as the feature name:
371377
'flm.main.feature_graphics_collection': {}
372378
373379
380+
381+
382+
Some additional configuration options
383+
-------------------------------------
384+
385+
Some additional keys inside the `flm:` block can help you set a default format,
386+
workflow, and template so you don't have to specify them on the command line.
387+
You can also set configuration variables for the templates.
388+
389+
.. code-block:: yaml
390+
391+
flm:
392+
# ...
393+
default_workflow: 'templatebasedworkflow'
394+
default_format: 'html'
395+
template:
396+
# template to use when rendering html
397+
html: 'simple'
398+
# template to use when rendering latex
399+
latex: 'revtex'
400+
template_config:
401+
html:
402+
simple:
403+
render_header: true
404+
display_toc: true
405+
font:
406+
family: 'Source Serif Pro'
407+
size: '16px'
408+
layout:
409+
content_width: '640px'
410+
style:
411+
extra_css: |
412+
body { background-color: #e7e7f7; }
413+
latex:
414+
simple:
415+
documentclass:
416+
fontsize: '12pt'
417+
preamble:
418+
fonts: |
419+
\usepackage{newtxtext}
420+
\usepackage{newtxmath}
421+
render_toc: true
422+
423+
424+
425+
374426
.. _config-formats:
375427

376428
Per-Format Configuration

0 commit comments

Comments
 (0)