Check Plugin
Documenting all checks¶
You can list all checks with the check directive:
:::{curvenote:check}
:::
Referencing checks inline¶
You can reference specific checks inline (or their options) with the check role: {curvenote:check}`Max Abstract Length <abstract-length.max>`
, for example see Max Abstract Length
Documenting one specific checks¶
You can also specify individual checks by id:
:::{curvenote:check} abstract-length
:::
Documenting filtered checks¶
You can specify category
and/or source
values to filter checks. Currently the only source
values are 'myst'
and 'curvenote'
; there are may category
values - these show up in the documented checks.
:::{curvenote:check}
:category: code
:source: myst
:::
Checks¶
The following are all available checks:
Abstract Exists¶
abstract
abstract-exists
Ensure abstract exists in MyST project
Abstract Length¶
abstract
abstract-length
Ensure abstract in MyST project is the correct length
- Options
- max (string, required)
Maximum word count for abstract
Availability Statement Exists¶
availability
availability-exists
Ensure availability statement exists in MyST project
Citation is unique¶
citation
citation-is-unique
Citation does not have any duplicate identifiers in the MyST project.
Bib file exists¶
citation
bib-file-exists
Bib file referenced in config file exists in the MyST project.
MyST citation checks pass¶
citation
myst-citation
No citation-related errors or warnings are produced during MyST build.
Code metadata lifted¶
code
code-metadata-lifted
Metadata defined on code is lifted to blocks; often failures are associated with multiple code metadata definitions within one block.
Code metatags valid¶
code
code-metatags-valid
Tags in code metadata must be a list of strings, and they must not conflict with each other.
Code lang defined¶
code
code-lang-defined
Code blocks should define their language
Code metadata loads¶
code
code-metadata-loads
Code metadata must be valid yaml.
Inline expression renders¶
code
inline-expression-renders
Inline expression must be a recognized mime bundle.
MyST code checks pass¶
code
myst-code
No code-related errors or warnings are produced during MyST build.
Known Directive¶
directive
directive-known
Check if directive is recognized.
Directive Argument Validates¶
directive
directive-argument-correct
Argument is valid, according to the rules of the specific directive.
Directive Options Validate¶
directive
directive-options-correct
Options are valid, according to the rules of the specific directive.
Directive Body Validates¶
directive
directive-body-correct
Body is valid, according to the rules of the specific directive.
MyST directive checks pass¶
directive
myst-directive
No directive-related errors or warnings are produced during MyST build.
DOCX Renders Successfully¶
export
docx-renders
The document renders to DOCX format without errors.
JATS Renders Successfully¶
export
jats-renders
The document renders to JATS format without errors.
Markdown Renders Successfully¶
export
md-renders
The document renders to Markdown format without errors.
MECA Includes JATS¶
export
meca-includes-jats
MECA bundle includes a single JATS document.
MECA Includes Manuscripts¶
export
meca-exports-built
Manuscript files (pdf, docx, etc) are built and included in MECA bundle.
MECA Includes Files¶
export
meca-files-copied
Files are copied successfully to MECA bundle.
PDF Builds Without Errors¶
export
pdf-builds-without-errors
PDF generation completes without errors.
PDF Builds Successfully¶
export
pdf-builds
The document builds to PDF format without errors.
TeX Renders Successfully¶
export
tex-renders
The document renders to TeX format without errors.
Export Extension Correct¶
export
export-extension-correct
The exported file has the correct file extension.
Exported Article Exists¶
export
export-article-exists
The exported article exists as expected.
MyST export checks pass¶
export
myst-export
No export-related errors or warnings are produced during MyST build.
Valid Config Structure¶
frontmatter
valid-config-structure
The configuration file has a valid structure.
Site Config Exists¶
frontmatter
site-config-exists
The site configuration file exists.
Project Config Exists¶
frontmatter
project-config-exists
The project configuration file exists.
Valid Site Config¶
frontmatter
valid-site-config
The site configuration is valid.
Valid Project Config¶
frontmatter
valid-project-config
The project configuration is valid.
Config Has No Deprecated Fields¶
frontmatter
config-has-no-deprecated-fields
There are no deprecated fields in the configuration file.
Frontmatter Is YAML¶
frontmatter
frontmatter-is-yaml
The frontmatter format is YAML.
Valid Page Frontmatter¶
frontmatter
valid-page-frontmatter
The page frontmatter is valid.
Valid Export List¶
frontmatter
valid-frontmatter-export-list
The frontmatter export list is valid.
MyST frontmatter checks pass¶
frontmatter
myst-frontmatter
No frontmatter-related errors or warnings are produced during MyST build.
Image Downloads¶
image
image-downloads
Remote images are downloaded successfully.
Image Exists¶
image
image-exists
The image exists on disk.
Image Format Converts¶
image
image-format-converts
Image format is converted successfully from unsupported to supported format.
Image Copied¶
image
image-copied
Image is copied successfully from source location.
Image Format Optimizes¶
image
image-format-optimizes
Images format is converted to webp for optimal web performance.
MyST image checks pass¶
image
myst-image
No image-related errors or warnings are produced during MyST build.
Valid MyST Link¶
link
myst-link-valid
Myst link to local or intersphinx content is valid.
Valid RRID Link¶
link
rrid-link-valid
The RRID link matches expected pattern.
Valid Wikipedia Link¶
link
wikipedia-link-valid
Wikipedia link matches expected pattern.
Valid DOI Link¶
link
doi-link-valid
DOI link is a valid DOI.
Link Resolves¶
link
link-resolves
Link can be successfully fetched.
MyST link checks pass¶
link
myst-link
No link-related errors or warnings are produced during MyST build.
Math Label Lifted¶
math
math-label-lifted
Enumerated math label is identified and lifted from latex.
Math Equation Env Removed¶
math
math-equation-env-removed
Equation environment is removed from latex.
Eqnarray Replaced¶
math
math-eqnarray-replaced
Latex align environment should be used instead of eqnarray.
Math Alignment Adjusted¶
math
math-alignment-adjusted
Math align environment renders correctly.
Math Renders Successfully¶
math
math-renders
Equation renders without any warning or errors.
MyST math checks pass¶
math
myst-math
No math-related errors or warnings are produced during MyST build.
MDAST Snippet Imports¶
miscellaneous
mdast-snippet-imports
MDAST snippet imports are resolved and loaded.
Include Content Filters¶
miscellaneous
include-content-filters
Line number filters apply to include content successfully.
Include Content Loads¶
miscellaneous
include-content-loads
Include content resolves and loads.
Gated Nodes Join¶
miscellaneous
gated-nodes-join
Gated nodes are successfully joined.
Glossary Uses Definition List¶
miscellaneous
glossary-uses-definition-list
Glossary contains terms as a definition list.
Block Metadata Loads¶
miscellaneous
block-metadata-loads
Block metadata is loaded successfully.
MyST miscellaneous content checks pass¶
miscellaneous
myst-miscellaneous
No miscellaneous content-related errors or warnings are produced during MyST build.
Notebook Attachments Resolve¶
notebook
notebook-attachments-resolve
Notebook attachments successfully load.
Notebook Output Copied¶
notebook
notebook-output-copied
Notebook output is copied to separate file.
MyST notebook checks pass¶
notebook
myst-notebook
No notebook-related errors or warnings are produced during MyST build.
TeX Parses¶
parse
tex-parses
TeX source file parses to MyST
JATS Parses¶
parse
jats-parses
JATS source file parses to MyST
MyST File Loads¶
parse
myst-file-loads
MyST markdown/notebook file parses to MyST
MyST parse checks pass¶
parse
myst-parse
No parse-related errors or warnings are produced during MyST build.
Reference Template Fills¶
reference
reference-template-fills
Template for reference enumeration is valid and fills.
Unique Identifier¶
reference
identifier-is-unique
Identifiers are unique.
Reference Target Resolves¶
reference
reference-target-resolves
Cross-reference target exists and resolves.
Valid Reference Syntax¶
reference
reference-syntax-valid
Cross-reference syntax is valid.
Explicit Reference Target¶
reference
reference-target-explicit
Cross-reference target is explicitly specified.
Footnote References Definition¶
reference
footnote-references-definition
Footnote references correctly point to their definitions.
Intersphinx References Resolve¶
reference
intersphinx-references-resolve
Intersphinx references successfully resolve.
MyST reference checks pass¶
reference
myst-reference
No reference-related errors or warnings are produced during MyST build.
Known Role¶
role
role-known
Check if role is recognized.
Role Body Validates¶
role
role-body-correct
Body is valid, according to the rules of the specific role.
MyST role checks pass¶
role
myst-role
No role-related errors or warnings are produced during MyST build.
Static File Copied¶
static
static-file-copied
Static site asset successfully copied.
Export File Copied¶
static
export-file-copied
Exported file is successfully copied.
Source File Copied¶
static
source-file-copied
Source file for MyST site is successfully copied.
Template File Copied¶
static
template-file-copied
Supporting template file is successfully copied.
Static Action File Copied¶
static
static-action-file-copied
Static site action file is successfully copied.
MyST static file checks pass¶
static
myst-static
No static-file-related errors or warnings are produced during MyST build.
TOC Contents Exist¶
toc
toc-contents-exist
The table of contents points to existing files.
Valid TOC Structure¶
toc
valid-toc-structure
The table of contents has a valid basic structure.
Valid TOC¶
toc
valid-toc
The table of contents is able to load.
MyST toc checks pass¶
toc
myst-toc
No toc-related errors or warnings are produced during MyST build.