1########## 2# remark # 3########## 4# remark — Markdown linter: 5# https://remark.js.org/ 6########### 7# Plugins # 8########### 9# Example file:10# https://github.com/zemanlx/container-structure-test-image/blob/master/.remarkrc.yaml11# [NOTE] I don't use “consistent” preset; these are not strict rules12# https://github.com/remarkjs/remark-lint#list-of-presets13# https://github.com/remarkjs/remark-lint/tree/master/packages/remark-preset-lint-consistent14plugins:15 preset-lint-recommended:16 preset-lint-markdown-style-guide:1718 #########19 # Rules #20 #########21 # Remark rules:22 # https://github.com/remarkjs/remark-lint/blob/master/doc/rules.md#list-of-rules23 # External rules:24 # https://github.com/remarkjs/remark-lint#list-of-external-rules25 # [NOTE] Markdown is markup for articles, not for code. User can write as much as he wants.26 lint-maximum-line-length: false27 # [INFO] Use “+” as unordered lists marker style:28 # https://github.com/remarkjs/remark-lint/tree/master/packages/remark-lint-unordered-list-marker-style29 # Possible fix all:30 # https://github.com/remarkjs/remark-lint/tree/master/packages/remark-lint-unordered-list-marker-style#fix31 lint-unordered-list-marker-style: +32 # [NOTE] I use mdx_downheader, that downgrade headers33 # https://github.com/cprieto/mdx_downheader34 lint-no-multiple-toplevel-headings: false35 # Why?36 lint-no-file-name-mixed-case: false37 # [FIXME] Valid symbols in URLs38 lint-no-file-name-irregular-characters: false39 # [NOTE] I can use literal URLs in Pelican metadata:40 # https://github.com/remarkjs/remark-lint/tree/master/packages/remark-lint-no-literal-urls41 lint-no-literal-urls: false42 # I use tabs, not spaces, see “.editorconfig” for details:43 # https://github.com/remarkjs/remark-lint/tree/master/packages/remark-lint-list-item-indent44 lint-list-item-content-indent: false45 # MarkdownTOC add unique ids for headers:46 # https://packagecontrol.io/packages/MarkdownTOC47 # https://github.com/naokazuterada/MarkdownTOC#auto-anchoring-when-heading-has-anchor-defined48 # https://github.com/remarkjs/remark-lint/tree/master/packages/remark-lint-no-duplicate-headings49 lint-no-duplicate-headings: false50 # [FIXME] Issue needest51 lint-list-item-spacing: false52 # Why?53 lint-maximum-heading-length: false54 # [FIXME] Issue needest:55 lint-list-item-indent: false56 # [FIXME] I use Pelican jtable:57 # https://github.com/remarkjs/remark-lint/tree/master/packages/remark-lint-no-shortcut-reference-link58 lint-no-shortcut-reference-link: false59 lint-no-undefined-references: false60 # [FIXME] Issue61 lint-no-inline-padding: false62 # [FIXME] Issue inline ignoring63 lint-code-block-style: false