Remarklint configuration for LobeHub projects

Features

• Markdown style guide enforcement
• GFM (GitHub Flavored Markdown) support
• Frontmatter support
• TOC (Table of Contents) generation
• CJK text formatting with pangu
• Write-good writing style suggestions
• Unused definition cleanup

Installation

pnpm add -D @lobehub/remarklint-config remark-cli

Usage

Create .remarkrc.js in your project root:

import config from '@lobehub/remarklint-config';

export default config;

Or for CommonJS:

module.exports = require('@lobehub/remarklint-config').default;

Run

# Check
pnpm remark . --quiet

# Fix
pnpm remark . --output

NPM Scripts

{
  "scripts": {
    "lint:md": "remark . --quiet",
    "lint:md:fix": "remark . --output"
  }
}

Included Plugins

Presets

• remark-preset-lint-consistent - Consistent style
• remark-preset-lint-recommended - Recommended rules
• remark-preset-lint-markdown-style-guide - Style guide

Features

• remark-gfm - GitHub Flavored Markdown
• remark-frontmatter - YAML frontmatter
• remark-toc - Table of Contents
• remark-pangu - CJK text spacing

Linting

• remark-lint-* - Various lint rules
• remark-lint-write-good - Writing style suggestions

Transformers

• remark-remove-unused-definitions - Cleanup
• remark-sort-definitions - Sort definitions

Requirements

• Node.js >= 18
• remark >= 15.0.0
• remark-cli >= 12.0.0

License

MIT © LobeHub