Markmeld templates

About

Here you'll find an API for public templates for the markmeld markdown melder. These templates define output structure for various output files, like resumes, biosketches, manuscripts, proposals, books, etc. using jinja.

How to use

Option 1: Use the remote API (recommended)

1. Add link to the mm_templates API.

Add this line to your _markmeld.yaml config file:
mm_templates: https://databio.org/mm_templates/

2. Specify relative path to a template.

Select a template from the list below and specify the relative path to the template in the target definition. For example:
target:
  my_target:
    jinja_template: v1/manuscript/manuscript.jinja
    data:
      ...

Option 2: Get the templates locally (for inaccessible compute)

Don't want to or can't use remote templates? No problem. You can just clone the template repository and point to the local files on disk.

1. Clone the mm_templates repository.

With https:
git clone --depth 1 https://github.com/databio/mm_templates.git
With ssh:
git clone --depth 1 git@github.com:databio/mm_templates.git

2. Add link to the mm_templates repo.

Add this line to your _markmeld.yaml config file:
mm_templates: local/path/to/mm_templates/

3. Specify relative path to a template.

Follow instructions for option 1 above!

List of templates (JSON)

Brought to you by: Sheffield lab of computational biology