Naming conventions

How to name files and usage of file extension.

---

File extension

Always use .md file extension.

remark-lint: file-extension (opens new window)

👍 Correct code for this rule:

install.md
about.md
faq.md

👎 Incorrect code for this rule:

install.gfm
about.mdk
faq.markdown

File naming

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

remark-lint: no-file-name-mixed-case (opens new window)

👍 Correct code for this rule:

install-dependencies.md
ui-design.md

👎 Incorrect code for this rule:

installDependencies.md
UiDesign.md
ui_design.md