MTGo Website

Documentation website for MTGo, a fast and idiomatic Go client library for the Telegram MTProto API.

The site is built with VitePress and deployed to GitHub Pages at:

https://mtgo-labs.github.io/website/

Contents

• Guides for installation, authentication, handlers, filters, middleware, and storage.
• API documentation for clients, configuration, messages, media, users, and generated types.
• CLI, plugin, advanced transport, and example pages.
• Generated Telegram TL constructor and method reference pages.

Development

Install dependencies:

npm ci

Run the local docs server:

npm run dev

Build the static site:

npm run build

Preview the production build:

npm run preview

TL Reference Generation

The generated TL documentation is produced from the MTGo source tree:

npm run tlgen

Note

npm run tlgen expects the main MTGo repository to exist at ../mtgo relative to this website directory.

Deployment

Deployments are handled by GitHub Actions in .github/workflows/deploy.yml.

Every push to main builds the VitePress site and publishes .vitepress/dist through GitHub Pages.