Skip to content

Latest commit

 

History

History
72 lines (45 loc) · 2.2 KB

README.md

File metadata and controls

72 lines (45 loc) · 2.2 KB
Raw

icon

SawaYch.github.io
Personal site boilerplate based on Gatsby Minimal TypeScript Starter

Code Check Deploy Gatsby SSG
This repository is not intended to be used as a Gatsby theme.
Instead, it serves as a boilerplate specifically designed for deploying Gatsby SSG sites to GitHub Pages (github.io).

🚀 Quick start

  1. Clone this repo

    # clone this repo
git clone https://github.com/sawaYch/sawaYch.github.io.git gatsby-site-boilerplate

  2. Restore dependencies

    Navigate into your new site’s directory, prepare to develop locally.

    cd gatsby-site-boilerplate/
npm ci

  3. Start developing

    Start it up.

    npm start

  4. Open the code and start customizing!

    Your site is now running at http://localhost:8000!

    Edit src/pages/index.tsx to see your site update in real-time!

🧰 Deploy

This site are design to use SSG (Static Site Generation) and deploy to github.io page.

By default, this repo use:

  • develop branch storing site codebase
  • master branch for the source hosting of Gatsby SSG bundled result.

Deploy this site using npm script or github action.

  1. Npm

    Please config git credential and the remote upstream first.

    Then run this command to deploy:

    npm run deploy

  2. Github Action

    Checkout the yaml file .github/workflows/deploy.yml.

    It is a manually triggered action.

    You will need an github access token of your repo, with repo write permission.