Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,10 @@ dist
dist-ssr
*.local

# ESLint plugin build artifacts
packages/*/dist
packages/*/node_modules

# Editor directories and files
.vscode/*
!.vscode/extensions.json
Expand Down
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,28 @@
This is a library for React that concisely manages heading levels.
Dependencies are React only, and 100% developed in TypeScript.

## Packages

This repository is a monorepo that contains:

- **[midashi](./lib)** - Core React components for heading hierarchy management
- **[eslint-plugin-midashi](./packages/eslint-plugin-midashi)** - ESLint plugin to enforce usage of midashi components

## Installation

```bash:npm
npm install midashi
npm install --save-dev eslint-plugin-midashi # Optional: ESLint plugin
```

```bash:yarn
yarn add midashi
yarn add --dev eslint-plugin-midashi # Optional: ESLint plugin
```

```bash:pnpm
pnpm add midashi
pnpm add --save-dev eslint-plugin-midashi # Optional: ESLint plugin
```

```bash:bun
Expand Down
Loading