Skip to content

add logo and GA #1

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.

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 2 commits into from
Feb 25, 2025
Merged
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
2 changes: 0 additions & 2 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,6 @@ jobs:
mkdocs build
mkdir sites
mv site sites/clash
env:
GOOGLE_ANALYTICS_KEY: ${{ secrets.GOOGLE_ANALYTICS_KEY }}

- name: Deploy
uses: peaceiris/actions-gh-pages@v3
Expand Down
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
site/
.venv/
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1 +1,14 @@
# watfaq.github.io

## Development

```bash
# Install dependencies
python3 -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
pip install mkdocs

# Run development server
mkdocs serve
```
Binary file added docs/artwork/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
15 changes: 0 additions & 15 deletions docs/index.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,18 +22,3 @@ ClashRS is a network proxy software that you can use to control how you want to
- ⚙️ Shadowsocks/Trojan/Vmess outbound support with different underlying trasports.
- 🌍 Dynamic remote rule/proxy loader.
- 🎵 Tracing with Jaeger



## Links

- Repository - https://github.com/Watfaq/clash-rs
- Download - https://github.com/Watfaq/clash-rs/releases

## Get Started

We've put together some helpful guides for you to get setup with our product quickly and easily.

[⌨️Getting set up](./quick-start/index.md)

[🔨Configuration](../config/index.md)
10 changes: 6 additions & 4 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ edit_uri: https://github.com/Watfaq/docs/blob/master/docs/
repo_name: clash-rs

theme:
logo: artwork/logo.png
favicon: artwork/logo.png
name: material
features:
- search.highlight
Expand Down Expand Up @@ -55,12 +57,12 @@ markdown_extensions:
- pymdownx.snippets

nav:
- Welcome: index.md
- Quick start:
- Welcome: index.md
- Quick start:
- quick-start/index.md
- CLI: quick-start/cli.md
- GUI: quick-start/gui.md
- Configuration:
- Configuration:
- config/index.md
- Full Example: config/full.md

Expand Down Expand Up @@ -94,7 +96,7 @@ plugins:
extra:
analytics:
provider: google
property: !ENV GOOGLE_ANALYTICS_KEY
property: G-YQC14KYW3F
social:
- icon: fontawesome/brands/github
link: https://github.com/Watfaq/clash-rs
Expand Down