Official developer documentation repository for the Telegram SMS project, built with VitePress.
- 🇬🇧 English only
npm installStart the local development server with hot reload:
npm run docs:devThe server will start at http://localhost:5173.
Build the static site:
npm run docs:buildBuild output will be located in the .vitepress/dist directory.
Preview the site after building:
npm run docs:previewThe main configuration file is located at .vitepress/config.mts, containing:
- Developer documentation navigation
- Sidebar structure for technical guides
- Theme customization settings
- Search functionality configuration
- Create a Markdown file in the
docs/directory - Add navigation links in
.vitepress/config.mtssidebar configuration - Follow the established documentation structure and style
- Use standard Markdown syntax
- Specify language for code blocks (e.g.,
typescript,kotlin) - Maintain consistent heading hierarchy (starting from
#) - Add appropriate links and cross-references
- Keep technical documentation clear and concise
{
"vitepress": "^1.5.0",
"typescript": "~5.7.2",
"prettier": "^3.4.2",
"@types/node": "^22.10.2"
}The documentation includes built-in local search functionality for quick access to technical information.
This documentation follows the same BSD 3-Clause License as the main Telegram SMS project.
For questions or suggestions:
- Submit a GitHub Issue
- Join the Telegram channel for discussions
- Check the documentation for technical guides
Maintainer: Telegram SMS Team
Last Updated: January 4, 2026