Skip to content

Commit b06da2a

Browse files
authored
Merge pull request #1 from Watfaq/add-logo-add-ga
add logo and GA
2 parents 7f03252 + 9998ce7 commit b06da2a

File tree

6 files changed

+20
-21
lines changed

6 files changed

+20
-21
lines changed

.github/workflows/deploy.yml

-2
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,6 @@ jobs:
2525
mkdocs build
2626
mkdir sites
2727
mv site sites/clash
28-
env:
29-
GOOGLE_ANALYTICS_KEY: ${{ secrets.GOOGLE_ANALYTICS_KEY }}
3028
3129
- name: Deploy
3230
uses: peaceiris/actions-gh-pages@v3

.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
11
site/
2+
.venv/

README.md

+13
Original file line numberDiff line numberDiff line change
@@ -1 +1,14 @@
11
# watfaq.github.io
2+
3+
## Development
4+
5+
```bash
6+
# Install dependencies
7+
python3 -m venv .venv
8+
source .venv/bin/activate
9+
pip install -r requirements.txt
10+
pip install mkdocs
11+
12+
# Run development server
13+
mkdocs serve
14+
```

docs/artwork/logo.png

58 KB
Loading

docs/index.zh.md

-15
Original file line numberDiff line numberDiff line change
@@ -22,18 +22,3 @@ ClashRS is a network proxy software that you can use to control how you want to
2222
- ⚙️ Shadowsocks/Trojan/Vmess outbound support with different underlying trasports.
2323
- 🌍 Dynamic remote rule/proxy loader.
2424
- 🎵 Tracing with Jaeger
25-
26-
27-
28-
## Links
29-
30-
- Repository - https://github.com/Watfaq/clash-rs
31-
- Download - https://github.com/Watfaq/clash-rs/releases
32-
33-
## Get Started
34-
35-
We've put together some helpful guides for you to get setup with our product quickly and easily.
36-
37-
[⌨️Getting set up](./quick-start/index.md)
38-
39-
[🔨Configuration](../config/index.md)

mkdocs.yml

+6-4
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ edit_uri: https://github.com/Watfaq/docs/blob/master/docs/
66
repo_name: clash-rs
77

88
theme:
9+
logo: artwork/logo.png
10+
favicon: artwork/logo.png
911
name: material
1012
features:
1113
- search.highlight
@@ -55,12 +57,12 @@ markdown_extensions:
5557
- pymdownx.snippets
5658

5759
nav:
58-
- Welcome: index.md
59-
- Quick start:
60+
- Welcome: index.md
61+
- Quick start:
6062
- quick-start/index.md
6163
- CLI: quick-start/cli.md
6264
- GUI: quick-start/gui.md
63-
- Configuration:
65+
- Configuration:
6466
- config/index.md
6567
- Full Example: config/full.md
6668

@@ -94,7 +96,7 @@ plugins:
9496
extra:
9597
analytics:
9698
provider: google
97-
property: !ENV GOOGLE_ANALYTICS_KEY
99+
property: G-YQC14KYW3F
98100
social:
99101
- icon: fontawesome/brands/github
100102
link: https://github.com/Watfaq/clash-rs

0 commit comments

Comments
 (0)