naming-conventions.md

File Extension

Always use .md file extension also for files with GFM syntax.

remark-lint: file-extension

Examples

⇣ Incorrect code for this rule:

ice.gfm
snow.mdk
frost.markdown

⇡ Correct code for this rule:

ice.md
snow.md
frost.md

File Naming

Always prefer spinal-case (also named kebab-case or hyphen-separated) for file names and use snake_case only if it contributes to a better understanding of the content.

remark-lint: no-file-name-mixed-case

Examples

⇣ Incorrect code for this rule:

winterSeason.md
IceCold.md
snow fall.md

⇡ Correct code for this rule:

winter_season.md
ice_cold.md
snow_fall.md

⇢ Recommended code for this rule:

winter-season.md
ice-cold.md
snow-fall.md