nonebot2/website
2022-02-04 15:12:02 +08:00
..
docs 📝 update some advanced docs 2022-02-04 15:12:02 +08:00
src 🐛 fix asciinema ssr failed 2022-01-30 18:26:26 +08:00
static 📝 update readme 2022-01-27 16:05:30 +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 🐛 fix missing api docs include 2022-01-23 13:35:09 +08:00
package.json 📝 add asciinema svg to install doc 2022-01-27 21:24:56 +08:00
README.md 🏗️ change doc theme 2021-12-01 16:28:55 +08:00
sidebars.js 📝 add plugin docs 2021-12-27 22:08:59 +08:00
tailwind.config.js 📝 update homepage 2021-12-03 16:21:24 +08:00
tsconfig.json 🎨 add store components 2021-12-29 21:09:36 +08:00
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.