@lottiefiles/remark-preset

Shared preset for Remark for formatting and linting Markdown files.

Table of contents

• Installation
  • Install Dependencies
• Usage
• Changelog

Installation

Install Remark CLI and this preset.

pnpm add -D remark-cli @lottiefiles/remark-preset

Install Dependencies

Peer Dependencies

| Package Name | Version | | ------------ | ------- | | puppeteer | * | | remark | * |

Optional Dependencies

| Package Name | Version | | --------------------------- | ------- | | install-chrome-dependencies | * |

Usage

1. Create a .remarkrc.mjs file in the project root and add the following content:

import remarkPreset from '@lottiefiles/remark-preset';
 
export default remarkPreset;

2. Create a .remarkignore file in the project and add the following content:

# Build artifacts
build/
dist/
artifacts/

# Changelog
CHANGELOG.md

# IDE related
.idea/
.history/

# Package management
node_modules/
.yarn/

# Testing
__fixtures__
coverage/
reports/

# Temporary or local data
temp/
tmp/

Changelog

See CHANGELOG.md for the latest changes.