Naming conventions

Key Point

💡 How to name files and usage of file extension

File extension

Always use .md file extension.

remark-lint: file-extension

👍 Correct code for this rule:

ice.md
snow.md
frost.md

👎 Incorrect code for this rule:

ice.gfm
snow.mdk
frost.markdown

File naming

Always prefer spinal-case (also named kebab-case or hyphen-separated) for file names.

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

👍 Correct code for this rule:

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

👎 Incorrect code for this rule:

winterSeason.md
IceCold.md
snow fall.md
snow_fall.md
Last Updated: 6/20/2019, 8:17:50 AM