Initial commit

This commit is contained in:
web@ppanel 2024-11-16 01:41:36 +07:00
commit 205dedfdcc
41 changed files with 272 additions and 0 deletions

68
README.md Normal file
View File

@ -0,0 +1,68 @@
<a name="readme-top"></a>
<div align="center">
<img width="160" src="https://raw.githubusercontent.com/perfect-panel/ppanel-assets/refs/heads/main/logo.svg">
<h1>PPanel Public tutorial</h1>
English
·
[Chinese](./README.zh-CN.md)
·
[Changelog](./CHANGELOG.md)
·
[Report Bug][issues-link]
·
[Request Feature][issues-link]
<!-- SHIELD GROUP -->
[![][github-contributors-shield]][github-contributors-link]
[![][github-forks-shield]][github-forks-link]
[![][github-stars-shield]][github-stars-link]
[![][github-issues-shield]][github-issues-link]
</div>
## 🤝 Contributing
Contributions of all types are more than welcome,
if you're interested in contributing code, feel free to check out our GitHub
[Issues][github-issues-link] to get stuck in to show us what youre made of.
[![][pr-welcome-shield]][pr-welcome-link]
[![][contributors-contrib]][contributors-url]
<!-- LINK GROUP -->
[back-to-top]: https://img.shields.io/badge/-BACK_TO_TOP-151515?style=flat-square
[codespaces-link]: https://codespaces.new/perfect-panel/ppanel-tutorial
[codespaces-shield]: https://github.com/codespaces/badge.svg
[contributors-contrib]: https://contrib.rocks/image?repo=perfect-panel/ppanel-tutorial
[contributors-url]: https://github.com/perfect-panel/ppanel-tutorial/graphs/contributors
[github-action-release-link]: https://github.com/perfect-panel/ppanel-tutorial/actions/workflows/release.yml
[github-action-release-shield]: https://img.shields.io/github/actions/workflow/status/perfect-panel/ppanel-tutorial/release.yml?label=release&labelColor=black&logo=githubactions&logoColor=white&style=flat-square
[github-action-test-link]: https://github.com/perfect-panel/ppanel-tutorial/actions/workflows/test.yml
[github-action-test-shield]: https://img.shields.io/github/actions/workflow/status/perfect-panel/ppanel-tutorial/test.yml?label=test&labelColor=black&logo=githubactions&logoColor=white&style=flat-square
[github-contributors-link]: https://github.com/perfect-panel/ppanel-tutorial/graphs/contributors
[github-contributors-shield]: https://img.shields.io/github/contributors/perfect-panel/ppanel-tutorial?color=c4f042&labelColor=black&style=flat-square
[github-forks-link]: https://github.com/perfect-panel/ppanel-tutorial/network/members
[github-forks-shield]: https://img.shields.io/github/forks/perfect-panel/ppanel-tutorial?color=8ae8ff&labelColor=black&style=flat-square
[github-issues-link]: https://github.com/perfect-panel/ppanel-tutorial/issues
[github-issues-shield]: https://img.shields.io/github/issues/perfect-panel/ppanel-tutorial?color=ff80eb&labelColor=black&style=flat-square
[github-license-link]: https://github.com/perfect-panel/ppanel-tutorial/blob/master/LICENSE
[github-license-shield]: https://img.shields.io/github/license/perfect-panel/ppanel-tutorial?color=white&labelColor=black&style=flat-square
[github-release-link]: https://github.com/perfect-panel/ppanel-tutorial/releases
[github-release-shield]: https://img.shields.io/github/v/release/perfect-panel/ppanel-tutorial?style=flat-square&sort=semver&logo=github
[github-releasedate-link]: https://github.com/perfect-panel/ppanel-tutorial/releases
[github-releasedate-shield]: https://img.shields.io/github/release-date/perfect-panel/ppanel-tutorial?labelColor=black&style=flat-square
[github-stars-link]: https://github.com/perfect-panel/ppanel-tutorial/network/stargazers
[github-stars-shield]: https://img.shields.io/github/stars/perfect-panel/ppanel-tutorial?color=ffcb47&labelColor=black&style=flat-square
[gitpod-link]: https://gitpod.io/#https://github.com/perfect-panel/ppanel-tutorial
[issues-link]: https://github.com/perfect-panel/ppanel-tutorial/issues/new/choose
[pr-welcome-link]: https://github.com/perfect-panel/ppanel-tutorial/pulls
[pr-welcome-shield]: https://img.shields.io/badge/🤯_pr_welcome-%E2%86%92-ffcb47?labelColor=black&style=for-the-badge
[profile-link]: https://github.com/perfect-panel

65
README.zh-CN.md Normal file
View File

@ -0,0 +1,65 @@
<a name="readme-top"></a>
<div align="center">
<img width="160" src="https://raw.githubusercontent.com/perfect-panel/ppanel-assets/refs/heads/main/logo.svg">
<h1>PPanel 公共教程</h1>
[英文](./README.md)
·
中文
·
[报告问题][issues-link]
·
[请求功能][issues-link]
<!-- SHIELD GROUP -->
[![][github-contributors-shield]][github-contributors-link]
[![][github-forks-shield]][github-forks-link]
[![][github-stars-shield]][github-stars-link]
[![][github-issues-shield]][github-issues-link]
</div>
## 🤝 贡献
欢迎各种类型的贡献,
如果您有兴趣贡献代码,请随时查看我们的 GitHub
[问题][github-issues-link] 来展示您的能力。
[![][pr-welcome-shield]][pr-welcome-link]
[![][contributors-contrib]][contributors-url]
<!-- LINK GROUP -->
[back-to-top]: https://img.shields.io/badge/-BACK_TO_TOP-151515?style=flat-square
[codespaces-link]: https://codespaces.new/perfect-panel/ppanel-tutorial
[codespaces-shield]: https://github.com/codespaces/badge.svg
[contributors-contrib]: https://contrib.rocks/image?repo=perfect-panel/ppanel-tutorial
[contributors-url]: https://github.com/perfect-panel/ppanel-tutorial/graphs/contributors
[github-action-release-link]: https://github.com/perfect-panel/ppanel-tutorial/actions/workflows/release.yml
[github-action-release-shield]: https://img.shields.io/github/actions/workflow/status/perfect-panel/ppanel-tutorial/release.yml?label=release&labelColor=black&logo=githubactions&logoColor=white&style=flat-square
[github-action-test-link]: https://github.com/perfect-panel/ppanel-tutorial/actions/workflows/test.yml
[github-action-test-shield]: https://img.shields.io/github/actions/workflow/status/perfect-panel/ppanel-tutorial/test.yml?label=test&labelColor=black&logo=githubactions&logoColor=white&style=flat-square
[github-contributors-link]: https://github.com/perfect-panel/ppanel-tutorial/graphs/contributors
[github-contributors-shield]: https://img.shields.io/github/contributors/perfect-panel/ppanel-tutorial?color=c4f042&labelColor=black&style=flat-square
[github-forks-link]: https://github.com/perfect-panel/ppanel-tutorial/network/members
[github-forks-shield]: https://img.shields.io/github/forks/perfect-panel/ppanel-tutorial?color=8ae8ff&labelColor=black&style=flat-square
[github-issues-link]: https://github.com/perfect-panel/ppanel-tutorial/issues
[github-issues-shield]: https://img.shields.io/github/issues/perfect-panel/ppanel-tutorial?color=ff80eb&labelColor=black&style=flat-square
[github-license-link]: https://github.com/perfect-panel/ppanel-tutorial/blob/master/LICENSE
[github-license-shield]: https://img.shields.io/github/license/perfect-panel/ppanel-tutorial?color=white&labelColor=black&style=flat-square
[github-release-link]: https://github.com/perfect-panel/ppanel-tutorial/releases
[github-release-shield]: https://img.shields.io/github/v/release/perfect-panel/ppanel-tutorial?style=flat-square&sort=semver&logo=github
[github-releasedate-link]: https://github.com/perfect-panel/ppanel-tutorial/releases
[github-releasedate-shield]: https://img.shields.io/github/release-date/perfect-panel/ppanel-tutorial?labelColor=black&style=flat-square
[github-stars-link]: https://github.com/perfect-panel/ppanel-tutorial/network/stargazers
[github-stars-shield]: https://img.shields.io/github/stars/perfect-panel/ppanel-tutorial?color=ffcb47&labelColor=black&style=flat-square
[gitpod-link]: https://gitpod.io/#https://github.com/perfect-panel/ppanel-tutorial
[issues-link]: https://github.com/perfect-panel/ppanel-tutorial/issues/new/choose
[pr-welcome-link]: https://github.com/perfect-panel/ppanel-tutorial/pulls
[pr-welcome-shield]: https://img.shields.io/badge/🤯_pr_welcome-%E2%86%92-ffcb47?labelColor=black&style=for-the-badge
[profile-link]: https://github.com/perfect-panel

47
SUMMARY.md Normal file
View File

@ -0,0 +1,47 @@
# Table of contents
## en-US
* [Windows](en-US/windows/README.md)
* [Clash Verge](en-us/windows/clash-verge.md)
* [Clash for Windows](en-us/windows/clash-for-windows.md)
* [Netch (Game/Special)](en-us/windows/netch.md)
* [macOS](en-us/macos/README.md)
* [Surge Pro](en-us/macos/surge-pro.md)
* [Clash Verge](en-us/macos/clash-verge.md)
* [ClashX Pro](en-us/macos/clashx-pro.md)
* [Android](en-us/android/README.md)
* [Surfboard](en-us/android/surfboard.md)
* [Clash for Android](en-us/android/clash-for-android.md)
* [sing-box](en-us/android/sing-box.md)
* [iOS / iPadOS](en-us/ios-ipados/README.md)
* [Surge](en-us/ios-ipados/surge.md)
* [Shadowrocket](en-us/ios-ipados/shadowrocket.md)
* [QuantumultX](en-us/ios-ipados/quantumultx.md)
* [sing-box](en-us/ios-ipados/sing-box.md)
* [Quantumult](en-us/ios-ipados/quantumult.md)
* [Router](en-us/router.md)
* [README](README.md)
## zh-CN
* [Windows](zh-CN/windows/README.md)
* [Clash Verge](zh-CN/windows/clash-verge.md)
* [Clash for Windows](zh-CN/windows/clash-for-windows.md)
* [Netch游戏/特殊)](zh-CN/windows/netch.md)
* [macOS](zh-CN/macos/README.md)
* [Surge Pro](zh-CN/macos/surge-pro.md)
* [Clash Verge](zh-CN/macos/clash-verge.md)
* [ClashX Pro](zh-CN/macos/clashx-pro.md)
* [Android](zh-CN/android/README.md)
* [Surfboard](zh-CN/android/surfboard.md)
* [Clash for Android](zh-CN/android/clash-for-android.md)
* [sing-box](zh-CN/android/sing-box.md)
* [iOS / iPadOS](zh-CN/ios-ipados/README.md)
* [Surge](zh-CN/ios-ipados/surge.md)
* [Shadowrocket](zh-CN/ios-ipados/shadowrocket.md)
* [QuantumultX](zh-CN/ios-ipados/quantumultx.md)
* [sing-box](zh-CN/ios-ipados/sing-box.md)
* [Quantumult](zh-CN/ios-ipados/quantumult.md)
* [Router](zh-CN/router.md)
* [README](README.zh-CN.md)

2
en-US/android/README.md Normal file
View File

@ -0,0 +1,2 @@
# Android

View File

@ -0,0 +1,2 @@
# Clash for Android

View File

@ -0,0 +1,2 @@
# sing-box

View File

@ -0,0 +1,2 @@
# Surfboard

View File

@ -0,0 +1,2 @@
# iOS / iPadOS

View File

@ -0,0 +1,2 @@
# Quantumult

View File

@ -0,0 +1,2 @@
# QuantumultX

View File

@ -0,0 +1,2 @@
# Shadowrocket

View File

@ -0,0 +1,2 @@
# sing-box

View File

@ -0,0 +1,2 @@
# Surge

2
en-US/macos/README.md Normal file
View File

@ -0,0 +1,2 @@
# macOS

View File

@ -0,0 +1,2 @@
# Clash Verge

View File

@ -0,0 +1,2 @@
# ClashX Pro

2
en-US/macos/surge-pro.md Normal file
View File

@ -0,0 +1,2 @@
# Surge Pro

10
en-US/router.md Normal file
View File

@ -0,0 +1,10 @@
# Router
* OpenWrt[https://github.com/vernesong/OpenClash/wiki](https://github.com/vernesong/OpenClash/wiki)
* Koolshare OpenWrt/LEDE[https://koolclash.js.org](https://koolclash.js.org)
* Merlin[https://github.com/KOP-XIAO/Clash-Merlin/wiki](https://github.com/KOP-XIAO/Clash-Merlin/wiki)
* ShellClash[https://github.com/juewuy/ShellClash](https://github.com/juewuy/ShellClash)
* Surge[https://qust.me/post/MacSurgeRouter](https://qust.me/post/MacSurgeRouter/)

2
en-US/windows/README.md Normal file
View File

@ -0,0 +1,2 @@
# Windows

View File

@ -0,0 +1,2 @@
# Clash for Windows

View File

@ -0,0 +1,2 @@
# Clash Verge

2
en-US/windows/netch.md Normal file
View File

@ -0,0 +1,2 @@
# Netch (Game/Special)

2
zh-CN/android/README.md Normal file
View File

@ -0,0 +1,2 @@
# Android

View File

@ -0,0 +1,2 @@
# Clash for Android

View File

@ -0,0 +1,2 @@
# sing-box

View File

@ -0,0 +1,2 @@
# Surfboard

View File

@ -0,0 +1,2 @@
# iOS / iPadOS

View File

@ -0,0 +1,2 @@
# Quantumult

View File

@ -0,0 +1,2 @@
# QuantumultX

View File

@ -0,0 +1,2 @@
# Shadowrocket

View File

@ -0,0 +1,2 @@
# sing-box

View File

@ -0,0 +1,2 @@
# Surge

2
zh-CN/macos/README.md Normal file
View File

@ -0,0 +1,2 @@
# macOS

View File

@ -0,0 +1,2 @@
# Clash Verge

View File

@ -0,0 +1,2 @@
# ClashX Pro

2
zh-CN/macos/surge-pro.md Normal file
View File

@ -0,0 +1,2 @@
# Surge Pro

10
zh-CN/router.md Normal file
View File

@ -0,0 +1,10 @@
# Router
* OpenWrt[https://github.com/vernesong/OpenClash/wiki](https://github.com/vernesong/OpenClash/wiki)
* Koolshare OpenWrt/LEDE[https://koolclash.js.org](https://koolclash.js.org)
* Merlin[https://github.com/KOP-XIAO/Clash-Merlin/wiki](https://github.com/KOP-XIAO/Clash-Merlin/wiki)
* ShellClash[https://github.com/juewuy/ShellClash](https://github.com/juewuy/ShellClash)
* Surge[https://qust.me/post/MacSurgeRouter](https://qust.me/post/MacSurgeRouter/)

2
zh-CN/windows/README.md Normal file
View File

@ -0,0 +1,2 @@
# Windows

View File

@ -0,0 +1,2 @@
# Clash for Windows

View File

@ -0,0 +1,2 @@
# Clash Verge

2
zh-CN/windows/netch.md Normal file
View File

@ -0,0 +1,2 @@
# Netch游戏/特殊)