Styleguide Markdown Save

An opinionated, yet universally applicable Markdown code style guide.

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

Learn about 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 Raw HTML, emphasizing and strings.

Remark Configurations

To follow the rules in a project and ensure that your code matches this style guide use the official extensible code linter rule preset @svengreb/remark-preset-lint for remark-lint, a plugin for remark.

Copyright © 2016-present Sven Greb