open-index/open-npm huggingface dataset:
npm package: @mulai-id/ui-kit
Description: ## CONTRIBUTING
Latest version: 0.0.31

# Raiden UIKIT

## CONTRIBUTING

Please read carefully for for the [contributing guidelines](./CONTRIBUTING.md)

## Design Principles

Understanding these concepts will help you better contribute

- Style Props

All component styles can be overridden or extended via style props to reduce the use of css prop or styled()

- Naming Props

We all know naming is the hardest thing in this industry. Generally, ensure a prop name is indicative of what it does. Boolean props should be named using auxiliary verbs such as does, has, is and should. For example, Button uses isDisabled, isLoading, etc.

- Simplicity

Strive to keep the component API fairly simple and show real world scenarios of using the component.

- Composition

Break down components into smaller parts with minimal props to keep complexity low, and compose them together. This will ensure that the styles and functionality are flexible and extensible.

## Expanding the ESLint configuration

If you are developing a production application, we recommend updating the configuration to enable type aware lint rules:

- Configure the top-level `parserOptions` property like this:

```js
export default {
  // other rules...
  parserOptions: {
    ecmaVersion: "latest",
    sourceType: "module",
    project: ["./tsconfig.json", "./tsconfig.node.json"],
    tsconfigRootDir: __dirname,
  },
};
```

- Replace `plugin:@typescript-eslint/recommended` to `plugin:@typescript-eslint/recommended-type-checked` or `plugin:@typescript-eslint/strict-type-checked`
- Optionally add `plugin:@typescript-eslint/stylistic-type-checked`
- Install [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react) and add `plugin:react/recommended` & `plugin:react/jsx-runtime` to the `extends` list

## Setting Up Custom Themes

### 1. Wrap your application with `RaidenProvider`

Ensure `RaidenProvider` wraps your main application component to provide the theme configuration context.

```jsx
import React from "react";
import { RaidenProvider } from "raiden"; // Replace 'raiden' with your actual context provider

const App = () => {
  return (
    <RaidenProvider theme={customTheme}>
      {/* Your application components */}
    </RaidenProvider>
  );
};
```

### 2. Use the createTheme function

To simplify creating or customizing a theme configuration, use the `createTheme` function provided:

```jsx
import { createTheme } from "src/utils";

const defaultTheme = createTheme();

// Example of creating a custom theme configuration
const customTheme = createTheme({
  colors: {
    light: {
      primary: "#FF5722", // Example primary color override
      background: {
        default: "#F5F5F5", // Example background color override
      },
    },
  },
});
```
npm package: @muleiwu/mdoc-mcp
Description: MCP server for mdoc document reading via OpenAPI
Latest version: 0.3.1

[English](README.md) | 简体中文

# mdoc-mcp

[mdoc](https://mdoc.cc) 的 MCP (Model Context Protocol) Server，让 AI 能够直接读取 mdoc 文档的目录结构和文章内容。

## 功能

- **`get_manifest`** — 获取文档目录清单（Markdown 格式），包含所有文章的层级结构和链接
- **`get_article_content`** — 获取文章的原始 Markdown 内容

## 安装与配置

### 1. 克隆并构建

```bash
git clone https://github.com/muleiwu/mdoc-mcp.git
cd mdoc-mcp
npm install
npm run build
```

### 2. 配置个人访问令牌

在 [mdoc](https://mdoc.cc) 用户设置页面创建个人访问令牌（PAT），令牌格式为 `mdoc_pat_*`。

### 3. 在 Cursor / Claude Desktop 中配置

编辑 MCP 配置文件（如 `~/.cursor/mcp.json` 或 Claude Desktop 的配置），添加：

```json
{
  "mcpServers": {
    "mdoc": {
      "command": "npx",
      "args": [
        "-y",
        "@muleiwu/mdoc-mcp"
      ],
      "env": {
        "MDOC_ACCESS_TOKEN": "mdoc_pat_your_token_here"
      }
    }
  }
}
```

如果使用私有部署的 mdoc，额外添加：

```json
"MDOC_API_BASE_URL": "https://your-mdoc-instance.com"
```

## 工具说明

### `get_manifest` — 获取文档目录

获取文档的完整目录清单，AI 可据此了解文档结构并选择要读取的文章。

**参数**（提供 `url` 或 `orgSlug` + `docSlug` 之一）：

| 参数 | 类型 | 说明 |
|------|------|------|
| `url` | string (可选) | mdoc 网址，如 `https://mdoc.cc/mliev/1ms` 或带版本 `https://mdoc.cc/mliev/1ms/v1.0.0` |
| `orgSlug` | string (可选) | 组织标识，如 `mliev` |
| `docSlug` | string (可选) | 文档标识，如 `1ms` |
| `version` | string (可选) | 版本名称，如 `v1.0.0`，不指定则使用默认版本 |

**返回**：Markdown 格式的文档目录，包含文章链接（可直接用于 `get_article_content`）

### `get_article_content` — 获取文章内容

获取指定文章的原始 Markdown 内容。

**参数**（提供 `url` 或 `orgSlug` + `docSlug` + `articleId` 之一）：

| 参数 | 类型 | 说明 |
|------|------|------|
| `url` | string (可选) | 网址或 manifest 中的 content.md 链接 |
| `orgSlug` | string (可选) | 组织标识 |
| `docSlug` | string (可选) | 文档标识 |
| `articleId` | string (可选) | 文章 ID |
| `version` | string (可选) | 版本名称 |

支持的 `url` 格式：
- `https://mdoc.cc/mliev/1ms/v1.0.0/16`（mdoc 网址，第 4 段为 articleId）
- `https://mdoc.cc/openapi/organizations/mliev/documents/1ms/articles/16/content.md`（manifest 返回的 API 链接）

## 典型使用流程

1. AI 调用 `get_manifest` 获取文档目录
2. 从目录中找到相关文章的链接
3. AI 调用 `get_article_content` 读取具体文章内容

## 环境变量

| 变量 | 必需 | 默认值 | 说明 |
|------|------|--------|------|
| `MDOC_ACCESS_TOKEN` | 是 | — | 个人访问令牌（格式：`mdoc_pat_*`） |
| `MDOC_API_BASE_URL` | 否 | `https://mdoc.cc` | API 基础地址（私有部署时使用） |

## License

MIT