sfz.dev

PC	SP

Official Corporate Web site of sforzando LLC. and Inc.

• Prerequisites
• How to
  • First time preparation
    • Introduce Congo
  • Start
    • Dummy Articles
  • Test
  • Deploy
  • Update
    • Dependencies
    • Congo
      • Endorse
  • Document
    • CHANGELOG
  • Clean
• Misc
• Notes
  • LICENSE
  • Contributors

Prerequisites

• Go (v1.18 or higher)
  • Hugo (v.0.108.0 or higher)
    • Congo
    • Vanta.js
• Node.js
  • Playwright
• Netlify
  • Netlify CLI
• Mapbox
  • Mapbox GL JS

How to

$ make help
default              常用
setup                初期
open                 閲覧
hide                 秘匿
reveal               暴露
start                開始
build                構築
watch                監視
format               整形
test                 試験
ngrok                転送
deploy               配備
update-dependencies  追随
update-theme         追随
endorse              裏書
clean                掃除
help                 助言

First time preparation

Prepare .envrc like this,

MAPBOX_ACCESS_TOKEN="xxxx"

Then, run make setup.

Introduce Congo

git submodule add -b stable https://github.com/jpanther/congo.git themes/congo

Start

make

Then, web server is available at http://0.0.0.0:1313/. To open it, make open.

Transfer by ngrok is convenient for checking on a smartphone, use make ngrok.

Dummy Articles

Generate dummy articles for testing.

for i in {0000..0023}; do
  for l in {en,ja}; do
    hugo new "works/${i}.ja.md"
  done
done

All dummy photos from Unsplash.

Test

E2E tests is available, make test.

Deploy

To deploy this to Netlify manually, make deploy.

Update

Dependencies

make update-dependencies

Congo

See. Congo official document.

make update

When the submodule is update, it may be necessary "Clear cache and deploy site." on Netlify.

Endorse

To confirm the differences from the latest Congo, make endorse.

Document

CHANGELOG

To install git-cliff via Homebrew manually, brew install git-cliff.

To update CHANGELOG.md manually, run git-cliff like below.

git cliff --output CHANGELOG.md

Clean

To clean up miscellaneous files, make clean.

Misc

Notes

This repository is Commitizen friendly, following GitHub flow.

LICENSE

See LICENSE.

Contributors

• sforzando LLC. and Inc.
  • Shin'ichiro Suzuki