kawofong.com

A personal website built using Docusaurus.

Pre-requisites

• pnpm

🧑🏻‍💻 Local Development

1. Clone the repository and install dependencies:

   git clone https://github.com/kawofong/web.git
   cd web
   pnpm install

2. Make changes to the source files.

3. Run the web page in development mode to see changes:

   pnpm start

Build

1. To create a production-optimized build, run:

   pnpm build

Deploy

There are many hosting services available, and I recommend GitHub Pages because it is easy to configure and free of charge. In addition, you can host your website using a personalized url (e.g. <username>.github.io) or a custom domain

Deploy to GitHub Pages

This repository has a GitHub Action workflow configured to deploy the Docusaurus site 🦖 to GitHub Pages.

1. Fork this repository

   If you want to use <username>.github.io as the url for your website, you would have to name your new public repository <username>.github.io. For more details, see https://pages.github.com/.

2. In your forked repository, configure GitHub Pages to build from GitHub Actions.

   

3. Follow instructions in the local development section (above) to make changes.

   Remember to update the baseUrl value in docusaurus.config.ts to match your url.

4. After you are done with your changes, commit and push your changes to the remote repository.