Files

Basit Ng 4de91ba651 Update README.md (#593 )

Updated the README file to include detailed instructions on how to use our project. This information will help new users get started quickly and understand the project's purpose.

2023-10-09 21:34:26 +08:00

assets

Remove all video files and use github instead

2023-08-22 22:31:40 +08:00

blog

Fix profile image

2023-07-27 00:16:59 +08:00

docs

Update README.md (#593 )

2023-10-09 21:34:26 +08:00

src

Remove all video files and use github instead

2023-08-22 22:31:40 +08:00

static

Remove all video files and use github instead

2023-08-22 22:31:40 +08:00

.gitignore

Revert .gitignore

2022-10-08 09:36:41 +08:00

babel.config.js

Update CI and add website

2022-10-05 14:44:56 +08:00

deploy.sh

Update build scripts and add netlify

2023-07-26 23:12:47 +08:00

docusaurus.config.js

Add google adsense

2023-07-27 01:10:14 +08:00

netlify.toml

Move .lfsconfig and update usage

2023-07-27 00:08:03 +08:00

package.json

Revert "Use react-youtube"

2023-08-05 16:36:24 +08:00

README.md

Add git-lfs in README.md

2023-07-26 08:29:44 +00:00

sidebars.js

Add performance comparison

2023-08-20 11:16:33 +08:00

tsconfig.json

Update CI and add website

2022-10-05 14:44:56 +08:00

README.md

Website

This website is built using Docusaurus 2, a modern static website generator.

Installation

When cloning the repository, make sure you have git-lfs installed. If you install git-lfs after cloning, simple run git lfs pull to download large files.

$ npm install

Local Development

$ npm 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

$ npm run 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 npm run deploy

Not using SSH:

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