Home

Initializing VitePress Site Documentation Project with GitHub Pages

1. Create a file named deploy-docs.yml inside the .github/workflows directory of your project with content similar to what is put here: .github/workflows/deploy-docs.yml

2. The GitHub CI/CD workflow will automatically create a GitHub Page using the source from GitHub Actions in the following path:

   Path: Organization Account – Your Repository – Settings – Pages

3. Add a custom domain for your website, such as docs.virakcloud.com in Path: Organization Account – Your Repository – Settings – Pages

4. Create a CNAME record for your custom domain, as identified in the previous section, that points to ORGANIZATION_NAME.github.io:

   docs.virakcloud.com CNAME virakcloud-org.github.io

5. Verify your domain in Organization -> Settings -> Pages.

6. Add an A record for comment.docs.virakcloud.com For Remark42 Comment Project pointing to the IP address: 185.212.194.139.

7. Configure the proxy server to pass all incoming traffic for comment.docs.virakcloud.com to the Remark42 comment server.

8. Create the following two secret environment variables:

   key : VITE_SITEURL value: https://docs.virakcloud.com

   key : VITE_COMMENT_URL value: https://comment.docs.virakcloud.com

9. The content of the CNAME file in the root and docs directories must be changed to docs.virakcloud.com