nonebot2/website
2021-12-02 14:03:06 +08:00
..
docs 🐛 fix build and ci bug 2021-12-02 14:03:06 +08:00
src 🏗️ change doc theme 2021-12-01 16:28:55 +08:00
static 🏗️ change doc theme 2021-12-01 16:28:55 +08:00
babel.config.js 🏗️ change doc theme 2021-12-01 16:28:55 +08:00
docusaurus.config.js 🐛 fix build and ci bug 2021-12-02 14:03:06 +08:00
package.json 🏗️ change doc theme 2021-12-01 16:28:55 +08:00
README.md 🏗️ change doc theme 2021-12-01 16:28:55 +08:00
sidebars.js 👷 update doc ci 2021-12-02 03:17:10 +08:00
tailwind.config.js 🏗️ change doc theme 2021-12-01 16:28:55 +08:00
tsconfig.json 🏗️ change doc theme 2021-12-01 16:28:55 +08:00

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 opens 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.