index.ts

import { remarkGfmHighlight } from './remarkGfmHighlight';
import { replaceNBSP } from './remarkTextrPlugins';

export default {
  $schema: 'https://json.schemastore.org/remarkrc',
  plugins: [
    'remark-gfm',
    'remark-frontmatter',
    'remark-pangu',
    ['remark-textr', { plugins: [replaceNBSP] }],
    remarkGfmHighlight,

    // ----- Plugin -----------------------------------------------------------
    'remark-sort-definitions',
    ['remark-toc', { heading: 'TOC', maxDepth: 3 }],
    'remark-remove-unused-definitions',

    // ----- Presets -----------------------------------------------------------
    'remark-preset-lint-markdown-style-guide',
    'remark-preset-lint-recommended',
    'remark-preset-lint-consistent',

    // ----- Built-In ----------------------------------------------------------
    'remark-lint-checkbox-content-indent',
    'remark-lint-linebreak-style',
    'remark-lint-no-duplicate-headings-in-section',
    'remark-lint-no-empty-url',
    'remark-lint-no-heading-indent',
    'remark-lint-no-heading-like-paragraph',
    'remark-lint-no-paragraph-content-indent',
    'remark-lint-no-reference-like-url',
    'remark-lint-no-tabs',
    'remark-lint-no-unneeded-full-reference-image',
    'remark-lint-no-unneeded-full-reference-link',

    // ----- External ----------------------------------------------------------
    'remark-lint-no-empty-sections',
    'remark-lint-write-good',
    'remark-lint-frontmatter-schema',

    // ----- Overrides ---------------------------------------------------------
    ['remark-lint-list-item-indent', 'space'],
    ['remark-lint-list-item-spacing', { checkBlanks: true }],
    ['remark-lint-no-duplicate-headings', false],
    ['remark-lint-no-file-name-irregular-characters', String.raw`\.a-zA-Z0-9-_`],
    ['remark-lint-no-file-name-mixed-case', false],
    ['remark-lint-no-literal-urls', false],
    ['remark-lint-no-shell-dollars', false],
    ['remark-lint-ordered-list-marker-value', false],
  ],
  settings: {
    bullet: '-',
    emphasis: '*',
    fences: true,
    rule: '-',
    strong: '*',
    tightDefinitions: true,
  },
};