Vale CMS Need more than a rule playground? Explore
Home

Research

Vale for research

Papers, notebooks, and the docs for the software research runs on.

Research produces two kinds of writing, often in the same repository: the paper, and the docs for the code behind it. For the paper, the Journals package turns the conventions every journal shares, the Nature and PLOS ONE guidelines, and the CONSORT, STROBE, and PRISMA checklists into rules read section by section, in Jupyter notebooks, Quarto, R Markdown, Typst, and MyST. For the docs, research groups from rOpenSci to Rubin Observatory already run Vale with a published style or one of their own.

Start with this config

The paper gets the shared conventions, the IMRaD structure, one journal’s guidelines, and the checklist for the study design; the docs get Google’s style, the most common choice among the research groups below. Vale prints a note that the docs section replaces the styles Journals turns on for every Markdown file: that is the point, since a README has no Methods section.

.vale.ini

StylesPath = styles
MinAlertLevel = suggestion
Packages = Journals, Google
Vocab = Journals

[paper/*.{md,qmd,ipynb}]
BasedOnStyles = Journals, IMRaD, PLOS, CONSORT
IMRaD.AbstractLength[max] = 300

[docs/**/*.md]
BasedOnStyles = Vale, Google

Then download the packages it names and run Vale over the project:

$ vale sync
$ vale .

Formats

Where this kind of writing lives. Vale parses each one, so rules see the prose and skip the markup, the code, and the URLs.