Maks1mS/nestjs-telegraf
0
0
Fork 0
mirror of https://github.com/Maks1mS/nestjs-telegraf.git synced 2024-12-24 23:14:39 +03:00
Code Issues Packages Projects Releases Wiki Activity
134726bebd
nestjs-telegraf/website
History
Aleksandr Bukhalo 134726bebd docs: remove full docs from README.md
2020-09-10 00:19:02 +03:00
..
docs docs: copy documentation from README.md into docusaurus docs 2020-09-09 23:40:23 +03:00
src chore: remove unused docusaurus features 2020-09-10 00:01:43 +03:00
static feat: add docusaurus for docs 2020-09-09 23:17:31 +03:00
babel.config.js feat: add docusaurus for docs 2020-09-09 23:17:31 +03:00
docusaurus.config.js docs: remove full docs from README.md 2020-09-10 00:19:02 +03:00
package-lock.json feat: add docusaurus for docs 2020-09-09 23:17:31 +03:00
package.json feat: add docusaurus for docs 2020-09-09 23:17:31 +03:00
README.md feat: add docusaurus for docs 2020-09-09 23:17:31 +03:00
sidebars.js docs: copy documentation from README.md into docusaurus docs 2020-09-09 23:40:23 +03:00
tsconfig.json feat: add docusaurus for docs 2020-09-09 23:17:31 +03:00

README.md

Website

This website is built using Docusaurus 2, a modern static website generator.

Installation

$ yarn

Local Development

$ yarn start

This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.

Build

$ yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

$ GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.