www_docs_threefold_io/docs_website
2024-08-25 12:45:50 -04:00
..
blog added website to main 2024-08-24 08:53:09 -04:00
docs updated docs, set order in presentation 2024-08-25 12:45:50 -04:00
src added support 2024-08-24 14:09:39 -04:00
static added social card 2024-08-24 12:54:32 -04:00
.gitignore added website to main 2024-08-24 08:53:09 -04:00
babel.config.js added website to main 2024-08-24 08:53:09 -04:00
docusaurus.config.ts updated docs, set order in presentation 2024-08-25 12:45:50 -04:00
package-lock.json added website to main 2024-08-24 08:53:09 -04:00
package.json added website to main 2024-08-24 08:53:09 -04:00
README.md added website to main 2024-08-24 08:53:09 -04:00
sidebars.ts added website to main 2024-08-24 08:53:09 -04:00
tsconfig.json added website to main 2024-08-24 08:53:09 -04: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.