journal_manager.cli.commands.template_commands.register module

journal_manager.cli.commands.template_commands.register.get_parser(subparser_action=None)

journal_manager.cli.commands.template_commands.register.register(template_name: str, template_path: Path)

Register a journal template.

A minimal journal template is composed of a mkdocs.yml file with optional placeholders. For example

site_name: {{journal.title}} theme: material

The placeholders follow the jinja2 package syntax. Here is the list of available placeholders:

• {{journal.title}}

• {{journal.name}}

• {{journal.location_folder}}

• {{journal.active}}

A journal template could have as many files as necessary and an arbitrary folder structure.

The template should be given as a path to the folder that contains the files that define the template. These files will be copied for each instance of journal that make use of that template.

Parameters:

• template_name (str) – Name of the template to be registered.

• template_path (Path) – Path to a directory containing the template files.