Deploy

commited date: 2023-07-23

Github Pages

Custom actions are available to deploy Scraps to Github Pages.

YAML file

Prepare a yaml file under .github/workflows/ like this

on: push
name: Build and deploy GH Pages
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - name: checkout
        uses: actions/checkout@v3
        with:
          fetch-depth: 0 # For scraps git commited date
      - name: build_and_deploy
        uses: boykush/scraps-deploy-action@v2
        env:
          # Target branch
          PAGES_BRANCH: gh-pages
          # Provide personal access token
          TOKEN: ${{ secrets.GITHUB_TOKEN }}

GitHub settings

Set up GitHub Pages for the repository.

Build and deployment parameter as follows.

Source: Deploy from a branch
Branch: gh-pages

Getting Started

Installation ❯ cargo install scraps mac OS ❯ brew install boykush/tap/scraps Init project git command is required for features ❯ scraps init your-scraps-project ❯ cd your-scraps-project The output result will look like this ❯ tree -a -L 1 . ├── .git ├── .gitignore ├── Config.toml └── scraps Configuration Edit Config.toml to settings. title = "your scraps project" See Configuration for other config. Write scraps Write markdown files under /scraps dir. ❯ tree scraps scraps ├── Getting Started.md └── Scraps.md See Scraps for scraps notation in markdown files. Build static site ❯ scraps build The output will be a slugged html file as follows. ❯ tree public public ├── getting-started.html ├── scraps.html ├── index.html └── main.css Debug server ❯ scraps serve You can debug the build outputs by visiting http://127.0.0.1:1112 Deploy pages See Deploy.