.remarkrc.yml

plugins:
  - preset-lint-recommended
  - remark-preset-lint-markdown-style-guide
  - [ remark-lint-validate-internal-links, {
      docsRoot: 'content/en',
      staticRoot: 'static',
      staticFilesExtensions: ['.json', '.js', '.yaml', '.sh', '.html', '.zip'],
      ignoreLinksThatStartWith: [
        'mailto', 'http', 'chrome'
      ],
      hugoShortcodesDirectory: "layouts/shortcodes/variables"
    }]
  # - [ remark-lint-no-dead-urls, {
  #     skipLocalhost: true,
  #     # gotOptions: {
  #     #   concurrency: 1,
  #     #   timeout: {
  #     #     lookup: 100,
  #     #     connect: 50,
  #     #     secureConnect: 50,
  #     #     socket: 1000,
  #     #     send: 5000,
  #     #     response: 1000
  #     #   }
  #     # }
  #   }]
  # https://github.com/remarkjs/remark-lint/blob/main/doc/rules.md
  - [ 'remark-frontmatter', 'yaml' ]
  - [ 'remark-lint-heading-style', 'atx' ]
  - [ 'remark-lint-maximum-line-length', false ]
  - [ 'remark-lint-no-emphasis-as-heading' ]
  - [ 'remark-lint-no-file-name-irregular-characters', '\\.a-zA-Z0-9_']
  - [ 'remark-lint-emphasis-marker', '_' ]
  - [ 'remark-lint-unordered-list-marker-style', '*' ]
  - [ 'remark-lint-list-item-indent', 'space' ]
  - [ 'remark-lint-list-item-spacing', false ]
  - [ 'remark-lint-no-empty-sections' ]
  - [ 'remark-lint-no-tabs' ]
  - [ 'remark-lint-first-heading-level', 2 ]
  - [ 'remark-lint-heading-sentence-case', [
      'API Builder',
      'Axway',
      'APIs',
      'Swagger',
      'Gmail',
      'OneDrive',
      'Google',
      'Docker',
      'Splunk',
      'API',
      'ID',
      'GUID',
      'API Manager',
      'HTTP',
      'OpenAPI',
      'Endpoint',
      'encodeURI',
      'Windows',
      'Amplify Runtime Services',
      'CRUD',
      'REST',
      'JSON',
      'Kafka',
      'Solace',
      'XSLT',
      'XML',
      'JSONPath',
      'JavaScript',
      'OAuth',
      'MBS',
      'ARS',
      'CLI',
      'doT',
      'HTML',
      'JWT',
      'URI'
    ]]
    # Lots of false positives. Sometimes it's expected but we don't want
    # this to be checking URLs, and want it to be a bit more flexible.
    # Otherwise it's really useful for catching wrong usage of words.
    # Consider replacing with some other sort of dictionary checker.
  - [ 'remark-lint-prohibited-strings', [
      { no: '[fF]low node', yes: 'flow-node' },
      { no: '[fF]low trigger', yes: 'flow-trigger' },
      # { yes: 'JavaScript' },
      { yes: 'Node.js' },
      { yes: 'npm' },
      { yes: 'CLI', ignoreNextTo: '-' },
      { yes: 'unix' },
      { yes: 'GitHub' },
      # { yes: 'Docker' },
      { yes: 'Axway', ignoreNextTo: '-' },
      { yes: 'Amplify', ignoreNextTo: '-' },
      # { yes: 'Oracle', ignoreNextTo: '-' },
      # { yes: 'JSONPath' },
      # the plugin doesn't handle URLs well
      # { yes: 'doT' },
      { yes: 'OAuth' },
      { no: 'JSON path', yes: 'JSONPath'},
      # { yes: 'JSONPath' },
      # the plugin doesn't handle regex too well, so wasn't able to use
      # negative lookbehind for use of 'builder' without preceding 'API'.
      # https://github.com/Trott/remark-lint-prohibited-strings/blob/main/index.js
      { no: 'builder', yes: 'Builder', ignoreNextTo: '-' },
      { yes: 'API Builder' }, # case insensitive
      { no: 'API First', yes: 'API-first' },
      { no: '[fF]alsey', yes: 'falsy' },
      { no: "[cC]an't", yes: 'cannot' },
      { no: "[iI]t's", yes: 'it is' },
      { no: "[tT]hat's", yes: 'that is' },
      { no: "[wW]hat's", yes: 'what is' },
      { no: "[wW]on't", yes: 'will not' },
      { no: "[yY]ou'd", yes: 'you would' },
      { no: "[yY]ou're", yes: 'you are' },
      { no: "[wR]e're", yes: 'we are' },
      { no: "(\\w+)'ve", yes: '$1 have', replaceCaptureGroups: true },
      { no: "(\\w+(?<!ca))n't", yes: '$1 not', replaceCaptureGroups: true },
      { no: "(\\w+)'ll", yes: '$1 will', replaceCaptureGroups: true },
      { no: "(\\w+)'d", yes: '$1 would', replaceCaptureGroups: true },
      { no: "(\\w+)'re", yes: '$1 are', replaceCaptureGroups: true },
      { no: 'oas|OAS', yes: 'OpenAPI' }
    ]]

  # We need to figure out what to do with these rules

  # too many exceptions
  - [ 'remark-lint-heading-sentence-case', false ]
  # Buggy AF for multi-indented lists
  - [ 'remark-lint-list-item-content-indent', false ]
  # shortcodes throw this off
  - [ 'remark-lint-maximum-heading-length', false ]