mellorjc / markdown-journal-linter

Check if a markdown file matches requirements for instructions for authors

markdown-journal-linter

Check if a markdown file matches requirements for instructions for authors

So far there are lua-filters for the following journals

• Diabetes Care
• Diabetologia

The checks are not exhaustive yet, but are just meant to help make sure checks for requirements that are easy-to-automate are done every time you compile your rmarkdown document.

Basic use

To use any of these filters, just add the filter to the YAML of your rmarkdown file

An example of this would be

---
title: "Example title"
abstract: >-
    Example abstract text
keywords: "keyword1,keyword2"
output:
    bookdown::pdf_book:
        base_format: rticles::elsevier_article
        keep_tex: true
        toc: false
        pandoc_args:
          - --lua-filter=check_markdown_authors_instructions.lua
---

Make sure it is the last filter in the pandoc_args list.

When you compile your rmarkdown document. For example by

rmarkdown::render('example.Rmd')

The filter should log information about how compliant your document is to the console.