https://github.com/svengreb/styleguide-markdown

An opinionated, yet universally applicable Markdown code style guide
https://github.com/svengreb/styleguide-markdown

codestyle commonmark consistency conventions documentation gfm hacktoberfest lint linter markdown md preset remark remark-lint standard style style-guide styleguide svengreb

Last synced: 4 months ago
JSON representation

An opinionated, yet universally applicable Markdown code style guide

• Host: GitHub
• URL: https://github.com/svengreb/styleguide-markdown
• Owner: svengreb
• License: mit
• Created: 2018-02-07T04:25:58.000Z (almost 7 years ago)
• Default Branch: main
• Last Pushed: 2023-04-27T10:44:07.000Z (almost 2 years ago)
• Last Synced: 2024-05-02T03:46:45.107Z (9 months ago)
• Topics: codestyle, commonmark, consistency, conventions, documentation, gfm, hacktoberfest, lint, linter, markdown, md, preset, remark, remark-lint, standard, style, style-guide, styleguide, svengreb
• Language: JavaScript
• Homepage:
• Size: 613 KB
• Stars: 32
• Watchers: 2
• Forks: 9
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md
  • Changelog: changelog.md
  • License: license
  • Codeowners: .github/codeowners

Awesome Lists containing this project

README

        


  

    

    

    

  





  

    

  

  

    

  

  

    

  





  

    

  





  

    

  





  

    

  

  

    

  



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][9] with support for [GitHub Flavored Markdown][10] which is based on the [CommonMark][1] specification. It includes rules for all document elements like e.g. [code blocks][2], [headings][4] or [lists][5], defines [naming conventions][6] and best practices for [Raw HTML][7], [emphasizing][3] and [strings][8].

### 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][12] for [remark-lint][11], a plugin for [remark][13].



  

    

    

    

  





  Copyright © 2016-present Sven Greb





  

    

  

  

    

  



[1]: https://commonmark.org

[2]: https://github.com/svengreb/styleguide-markdown/blob/main/rules/code.md

[3]: https://github.com/svengreb/styleguide-markdown/blob/main/rules/emphasis.md

[4]: https://github.com/svengreb/styleguide-markdown/blob/main/rules/headings.md

[5]: https://github.com/svengreb/styleguide-markdown/blob/main/rules/lists.md

[6]: https://github.com/svengreb/styleguide-markdown/blob/main/rules/naming-conventions.md

[7]: https://github.com/svengreb/styleguide-markdown/blob/main/rules/raw-html.md

[8]: https://github.com/svengreb/styleguide-markdown/blob/main/rules/strings.md

[9]: https://github.com/svengreb/styleguide-markdown/blob/main/rules/index.md

[10]: https://github.github.com/gfm

[11]: https://github.com/remarkjs/remark-lint

[12]: https://github.com/svengreb/styleguide-markdown/tree/main/packages/@svengreb/remark-preset-lint

[13]: https://remark.js.org