Skip to content

Writing Guide

This is a guide for best practices when contributing to the NOMAD documentation.

Images and Data

All assets specific to an individual markdown file should be stored within an immediate sub-directory of the file, labeled accordingly. Please use images/ and data/ for the image and data files, respectively.

Sections Hierarchy

single "#" sections should only be used at the beginning of the md file

Use for external links to open a new browser window.

Admonitions

Here is a list of currently used admonitions within the docs:

  • Attention

  • Note

  • Tip

  • Important