The Arctic Ice Studio Markdown Code Style.

Every major open source project has its own style guide, a set of standards and conventions for the writing and design of code, documentations and assets. It is much easier to understand a large codebase when all the code in it is in a consistent style.

A style guide establishes and enforces style to improve the intelligibility and communication within the project community. It ensures consistency and enforces best practice in usage and language composition.

Getting Started

This style guide provides the comprehensive base rule set with support for GitHub Flavored Markdown which is based on the CommonMark specification. It includes rules for all document elements like e.g. code blocks, headings or lists, defines naming conventions and best practices for whitespaces, Raw HTML, emphasizing and strings.

The development chapters contain information about the requirements and how to build this style guide documentation.

To make sure your code matches this style guide use the official remark-preset-lint-arcticicestudio code linter preset for remark-lint, a plugin for remark.


Read the contributing guide to learn about the development process and how to propose enhancement suggestions and report bugs, how to submit pull requests and the project's styleguides, branch organization and versioning model.

The guide also includes information about minimal, complete, and verifiable examples and other ways to contribute to the project like improving existing issues and giving feedback on issues and pull requests.

Copyright © 2018-present Arctic Ice Studio & Sven Greb

results matching ""

    No results matching ""