Browser docs

Style Guide

December 14, 2022 1 min read Develop Docs CSS HTML JavaScript SCSS Style Guide TypeScript
On this page

Undoubtedly, the same coding style helps developers to cooperate with each other. We suggest taking a few minutes to learn about the coding style used, if you’re going to help us improve the code.

TypeScript Style Guide

We use eslint to check the TypeScript and JavaScript styles.

1npm run eslint

SCSS Style Guide

We use stylelint to check the SCSS styles.

1npm run stylelint

Hugo Style Guide

Naming Conventions

Parameters Naming Convention

Since Hugo parameters are case-insensitive, snake_case are preferred.

Parameter
FooBar❌
fooBar❌
foobar❌
foo-bar❌
foo_bar✅

File Naming Convention

The filenames are case-sensitive on most file systems, so we recommend always using kebab-case.

Filename
fooBar.html❌
foo-bar.html✅

Variables Naming Conventions

  1. Use PascalCase for exported variables, as Go does.
  2. Use camelCase for local variables.