mini-strap/packages/website
Alexander Navarro 85660ac08a
Some checks failed
Publish package / build_and_publish (push) Failing after 23s
chore(website): add docosaurus as SSG
2024-11-10 22:18:21 +00:00
..
blog chore(website): add docosaurus as SSG 2024-11-10 22:18:21 +00:00
docs chore(website): add docosaurus as SSG 2024-11-10 22:18:21 +00:00
src chore(website): add docosaurus as SSG 2024-11-10 22:18:21 +00:00
static chore(website): add docosaurus as SSG 2024-11-10 22:18:21 +00:00
.gitignore chore(website): add docosaurus as SSG 2024-11-10 22:18:21 +00:00
docusaurus.config.ts chore(website): add docosaurus as SSG 2024-11-10 22:18:21 +00:00
package.json chore(website): add docosaurus as SSG 2024-11-10 22:18:21 +00:00
README.md chore(website): add docosaurus as SSG 2024-11-10 22:18:21 +00:00
sidebars.ts chore(website): add docosaurus as SSG 2024-11-10 22:18:21 +00:00
tsconfig.json chore(website): add docosaurus as SSG 2024-11-10 22:18:21 +00:00

Website

This website is built using Docusaurus, 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

Using SSH:

$ USE_SSH=true yarn deploy

Not using SSH:

$ GIT_USER=<Your GitHub username> 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.