Yet Another Tunnel

YAT Official Website

Official website for YAT (Yet Another Tunnel) - Making intranet penetration simpler and more secure.

Tech Stack

Framework: VitePress
Language: Vue 3 + TypeScript
Deployment: Cloudflare Pages / GitHub Pages
i18n: English, 简体中文, Español

Project Structure

yat.github.io/
├── docs/
│   ├── .vitepress/
│   │   └── config.js          # VitePress configuration
│   ├── public/                 # Static assets
│   │   └── images/
│   │
│   ├── # Main pages (in nav)
│   ├── index.md               # Homepage
│   ├── features.md            # Features page
│   ├── download.md            # Download page
│   ├── pricing.md             # Pricing page
│   ├── blog/                  # Blog
│   │   └── index.md
│   │
│   ├── # Documentation
│   ├── guide/                 # User guide
│   ├── developer/             # Developer docs
│   │
│   └── # Hidden pages (footer links)
│       ├── about.md
│       ├── privacy.md
│       ├── terms.md
│       └── changelog.md
│
├── package.json
└── README.md

Development

Prerequisites

Node.js 18+
npm or yarn

Install Dependencies

npm install

Development Server

npm run docs:dev

The site will be available at http://localhost:5173

Build

npm run docs:build

Output will be in docs/.vitepress/dist/

Preview Production Build

npm run docs:preview

Deployment

Cloudflare Pages

Connect your GitHub repository to Cloudflare Pages
Configure build settings:
- Build command: npm run docs:build
- Build output directory: docs/.vitepress/dist
Deploy!

GitHub Pages

The site will auto-deploy via GitHub Actions on push to main branch.

Multi-language Support

The website supports three languages:

English (default): /
简体中文: /zh/
Español: /es/

Language configuration is in docs/.vitepress/config.js.

Contributing

We welcome contributions! Please see our Contributing Guide for details.

Fork the repository
Create your feature branch (git checkout -b feature/amazing-feature)
Commit your changes (git commit -m 'Add some amazing feature')
Push to the branch (git push origin feature/amazing-feature)
Open a Pull Request

License

This project is licensed under the MIT License - see the LICENSE file for details.