zrok/website
Rui Chen ed7f19dc9c
chore: normalize encoding for the text files
Signed-off-by: Rui Chen <rui@chenrui.dev>
2024-02-12 21:00:52 +01:00
..
src use ThemedImage component instead of CSS to switch frontdoor diagram dark mode 2023-12-07 11:29:02 -05:00
static chore: normalize encoding for the text files 2024-02-12 21:00:52 +01:00
.gitignore add package-lock and unignore 2023-01-27 22:12:49 -05:00
.nvmrc organize download and install info as guides and add nice downloads 2023-11-22 23:00:48 -05:00
algolia-crawler-config.js add a crawler schedule 2024-01-12 00:11:41 -05:00
babel.config.js initial attempt at website 2023-01-25 16:04:35 -05:00
docusaurus.config.js replace tag with tag manager 2024-01-23 14:35:53 -05:00
package-lock.json bump docusaurus version 2024-01-12 00:12:08 -05:00
package.json bump docusaurus version 2024-01-12 00:12:08 -05:00
README.md initial attempt at website 2023-01-25 16:04:35 -05:00
sidebars.js initial attempt at website 2023-01-25 16:04:35 -05:00
vercel.json try again to ignore gh-pages 2023-02-21 20:43:18 -05: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

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.