Mirror of https://github.com/typegoose/typegoose
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
|
2 days ago | |
---|---|---|
.. | ||
src | 7 months ago | |
static | 3 years ago | |
.gitignore | 3 years ago | |
README.md | 7 months ago | |
babel.config.js | 3 years ago | |
docusaurus.config.js | 8 months ago | |
package.json | 2 days ago | |
sidebars.js | 1 week ago | |
yarn.lock | 2 days ago |
README.md
This website is built using Docusaurus 2, a modern static website generator.
Note: yarn
is required, otherwise some plugins don't work
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.