Codeguide is the open-source code style guide of HTML Academy, a Russian online education platform, that turns the Academy's HTML, CSS, and JavaScript conventions into a public reference site at codeguide.academy plus ready-made linting packages.
What is Codeguide?
Codeguide is a public, MIT-licensed style guide maintained by HTML Academy and published at codeguide.academy. It takes the coding conventions taught in the Academy's frontend courses and packages them as markdown source files in a GitHub repository, alongside EditorConfig, ESLint, Stylelint, and HTMLHint configurations. The repository explicitly credits four existing guides as its basis: Code Guide by @mdo, CSS Guidelines by Harry Roberts, Idiomatic CSS by Nicolas Gallagher, and Primer Guidelines by GitHub.
Key Features
- Public reference site — the guide is readable online at codeguide.academy, with the raw markdown source kept in sync on GitHub.
- MIT license — the full content and linter configs can be reused, modified, and redistributed freely with attribution.
- ESLint configuration — the eslint-config-htmlacademy package encodes the Academy's JavaScript style rules for automated checking.
- Stylelint configuration — the stylelint-config-htmlacademy package applies the Academy's CSS formatting and ordering rules.
- HTMLHint configuration — the htmlhint-config-htmlacademy package validates HTML markup against the same standards.
- EditorConfig preset — the repository includes an .editorconfig for consistent indentation, charset, and line endings.
- Documented lineage — the acknowledgments section names the four external guides that shaped the recommendations, making the conventions auditable.
Who is it for?
Codeguide suits anyone who writes, teaches, or reviews frontend code and wants a single, agreed-upon rulebook. The people who get the most from it include:
- HTML Academy students — match the house style the Academy expects when instructors review their coursework and practical assignments.
- Frontend developers — adopt a ready-made rulebook and linter presets instead of writing project conventions from scratch.
- Teams that value consistency — point code reviewers at one public URL (codeguide.academy) as the shared standard for HTML, CSS, and JavaScript.
What can you do with Codeguide?
Codeguide gives you both a human-readable rulebook and machine-checkable rules for the same conventions. These are the concrete ways people put it to work:
- Students and self-learners: run the Academy's ESLint, Stylelint, and HTMLHint packages locally so their code is checked against the same rules instructors use.
- Open-source maintainers: fork the MIT-licensed configs and adapt them to their own project conventions.
- Technical writers: borrow the structure and recommendation style of the guide when building an internal frontend styleguide.
How does Codeguide work?
The repository stores the guide as markdown and exposes linting rules as three packages: eslint-config-htmlacademy, stylelint-config-htmlacademy, and htmlhint-config-htmlacademy. A developer installs these packages into a project, and editors plus CI pipelines then flag code that violates the Academy's conventions.
Pricing
Codeguide is free to use. The source repository is released under the MIT license, and the public version of the site is openly accessible.
Alternatives
- Code Guide by @mdo — the widely referenced HTML and CSS style guide that Codeguide credits as an influence.
- CSS Guidelines by Harry Roberts — a CSS-focused style guide that is also named in the acknowledgments.
- Primer Guidelines by GitHub — the design-system style guide from GitHub listed among the influences.
FAQ
Is Codeguide free?
Yes. The entire guide, including the linter configurations, is published under the MIT license, so it can be used, modified, and redistributed freely with attribution.
What linters does Codeguide support?
Codeguide ships EditorConfig, ESLint, Stylelint, and HTMLHint configurations. The three linting packages are named eslint-config-htmlacademy, stylelint-config-htmlacademy, and htmlhint-config-htmlacademy.
Where does Codeguide come from?
Codeguide is maintained by HTML Academy and draws on four credited sources: Code Guide by @mdo, CSS Guidelines by Harry Roberts, Idiomatic CSS by Nicolas Gallagher, and Primer Guidelines by GitHub.
Where can I read Codeguide?
The public version is published at codeguide.academy, and the raw markdown source plus linter configurations live in the HTML Academy GitHub repository under the MIT license.
