Skip to content

telosnetwork/telos-docs

Repository files navigation

Telos Docs

docs.telos.net

About

Welcome to the Telos Docs. The Telos documentation is aimed to provide a list of comprehensive guides in building on Telos for web2 and web3 developers. You can fork the docs and work in a local environment or do a PR directly on one of the pages.

Please reach out in EVM or Dapps development Telegram channels.

Our docs are built using Docusaurus 3, a modern static website generator.

Site will auto-update based on commits to the master branch, it is hosted in Cloudflare Pages.

Recent Contributions

Alt

Installation

Clone repository and install dependencies

$ git clone https://github.com/telosnetwork/telos-docs.git
$ cd telos-docs
$ yarn

Start local development server

$ yarn start

Generate production build (in build directory) which can be served using any static hosting service

$ yarn build

Deployment

Using SSH:

$ USE_SSH=true yarn deploy

Not using SSH:

$ GIT_USER=<Your GitHub username> yarn deploy