nonebot2/website
2022-01-22 15:35:52 +08:00
..
docs 🎨 improve tree style 2022-01-22 15:35:52 +08:00
src 🏷️ add pre-commit flow 2022-01-15 21:27:43 +08:00
static 🏷️ add pre-commit flow 2022-01-15 21:27:43 +08:00
versioned_docs/version-2.0.0-beta.1 ✏️ fix context shell command typo 2022-01-11 12:53:19 +08:00
versioned_sidebars 🔖 Release 2.0.0-beta.1 2022-01-08 09:34:38 +00:00
babel.config.js 🏷️ add pre-commit flow 2022-01-15 21:27:43 +08:00
docusaurus.config.js 🏷️ add pre-commit flow 2022-01-15 21:27:43 +08:00
package.json 📝 add examples 2022-01-07 18:38:04 +08:00
README.md
sidebars.js
tailwind.config.js
tsconfig.json
versions.json 🏷️ add pre-commit flow 2022-01-15 21:27:43 +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.