Skip to content

docs: update Custom Player Page root readme & remove changelog #49

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 24, 2025
Merged

docs: update Custom Player Page root readme & remove changelog #49

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
91 changes: 0 additions & 91 deletions CHANGELOG.md
View file
Open in desktop

This file was deleted.

16 changes: 16 additions & 0 deletions README-ko_kr.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -264,6 +264,22 @@ YouTube 플레이어 렌더링 방식을 제어하고 호환성을 위한 소스
/>
```

**커스텀 플레이어 페이지**

직접 제작한 커스텀 플레이어 페이지를 사용하려면, `@react-native-youtube-bridge/web`을 활용하여 React 기반의 플레이어 페이지를 구축할 수 있습니다.

```tsx
import { YoutubePlayer } from '@react-native-youtube-bridge/web';

function CustomPlayerPage() {
return <YoutubePlayer />;
}

export default CustomPlayerPage;
```

> 자세한 내용은 [웹 플레이어 가이드](./packages/web/)를 참고해 주세요.
Comment on lines +267 to +281
Copy link

@coderabbitai coderabbitai bot Jun 24, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

헤딩 형식 통일 및 MD036 해결 – 굵게 처리된 텍스트를 헤딩으로 전환하세요.

영문 README와 동일하게 **커스텀 플레이어 페이지** 대신 ### 헤딩을 사용하면
(1) lint 오류(MD036)를 제거하고, (2) 자동 목차·스타일 일관성을 유지할 수 있습니다.

-**커스텀 플레이어 페이지**
+### 커스텀 플레이어 페이지
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
**커스텀 플레이어 페이지**
직접 제작한 커스텀 플레이어 페이지를 사용하려면, `@react-native-youtube-bridge/web`을 활용하여 React 기반의 플레이어 페이지를 구축할 수 있습니다.
```tsx
import { YoutubePlayer } from '@react-native-youtube-bridge/web';
function CustomPlayerPage() {
return <YoutubePlayer />;
}
export default CustomPlayerPage;
```
> 자세한 내용은 [웹 플레이어 가이드](./packages/web/)를 참고해 주세요.
### 커스텀 플레이어 페이지
직접 제작한 커스텀 플레이어 페이지를 사용하려면, `@react-native-youtube-bridge/web`을 활용하여 React 기반의 플레이어 페이지를 구축할 수 있습니다.
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

267-267: Emphasis used instead of a heading
null

(MD036, no-emphasis-as-heading)

🤖 Prompt for AI Agents 
In README-ko_kr.md around lines 267 to 281, the section title is formatted as
bold text instead of a proper markdown heading, causing lint error MD036 and
inconsistency with the English README. Replace the bold text "**커스텀 플레이어 페이지**"
with a markdown heading using "### 커스텀 플레이어 페이지" to fix the lint error and
maintain consistent styling and automatic table of contents generation.


## 기여하기

리포지토리 기여 방법과 개발 워크플로우를 알아보려면 [기여 가이드](CONTRIBUTING.md)를 참고하세요.
Expand Down
16 changes: 16 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -264,6 +264,22 @@ Control YouTube player rendering method and configure source URLs for compatibil
/>
```

**Custom Player Page**

To use your own custom player page, you can build a React-based player using `@react-native-youtube-bridge/web`.

```tsx
import { YoutubePlayer } from '@react-native-youtube-bridge/web';

function CustomPlayerPage() {
return <YoutubePlayer />;
}

export default CustomPlayerPage;
```

> For more details, please refer to the [Web Player Guide](./packages/web/).
Comment on lines +267 to +281
Copy link

@coderabbitai coderabbitai bot Jun 24, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Convert bolded text to a proper Markdown heading to satisfy MD036 and keep the TOC consistent.

markdownlint flags the current emphasis (**Custom Player Page**) because it’s being used as a heading.
Every other subsection (e.g. “### Events”, “### Functions”) already uses ###-style headings, so keeping the same convention avoids breaking automatic TOC generators and keeps the style uniform.

-**Custom Player Page**
+### Custom Player Page
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
**Custom Player Page**
To use your own custom player page, you can build a React-based player using `@react-native-youtube-bridge/web`.
```tsx
import { YoutubePlayer } from '@react-native-youtube-bridge/web';
function CustomPlayerPage() {
return <YoutubePlayer />;
}
export default CustomPlayerPage;
```
> For more details, please refer to the [Web Player Guide](./packages/web/).
### Custom Player Page
To use your own custom player page, you can build a React-based player using `@react-native-youtube-bridge/web`.
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

267-267: Emphasis used instead of a heading
null

(MD036, no-emphasis-as-heading)

🤖 Prompt for AI Agents 
In README.md around lines 267 to 281, the text "Custom Player Page" is currently
bolded but should be converted to a proper Markdown heading to comply with
markdownlint rule MD036 and maintain TOC consistency. Replace the bolded text
with a heading using the same style as other subsections, such as prefixing it
with "###" to make it a level 3 heading.


## Contributing

See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow.
Expand Down