diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index 728b6e7..0aefcda 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -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 diff --git a/.gitignore b/.gitignore index 45ddf0a..244a97c 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,2 @@ site/ +.venv/ \ No newline at end of file diff --git a/README.md b/README.md index c13ff6f..5a31bf7 100644 --- a/README.md +++ b/README.md @@ -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 +``` \ No newline at end of file diff --git a/docs/artwork/logo.png b/docs/artwork/logo.png new file mode 100644 index 0000000..b90983c Binary files /dev/null and b/docs/artwork/logo.png differ diff --git a/docs/index.zh.md b/docs/index.zh.md index e446d4e..1ce4c90 100644 --- a/docs/index.zh.md +++ b/docs/index.zh.md @@ -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) \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 0f11cf1..9499091 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -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 @@ -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 @@ -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