<@inksafari/engawa_svx />

Prerequisites

• Git ( Flight rules for Git )
• Node.js >=16.14 or later
• pnpm ( optional, although strongly recommended )

for fontSubset.sh

• ripgrep ( Rust )
• fonttools ( Python )

# for CJK users (macOS/Homebrew)
brew install ripgrep
pip3 install fonttools brotli zopfli unicodedata2

(back to top)

Installation

To clone it and get started:

git clone --depth=1 [email protected]:inksafari/engawa.git
cd engawa
npm install
npm run dev

Open up localhost:9000 and start clicking around.

Consult kit.svelte.dev for help getting started.

(back to top)

Available Scripts

All commands are run from the root of the project, from a terminal:

Command	Action
npm install	Installs dependencies
npm run dev	Starts local dev server at localhost:9000
npm run build	Build your production site to ./build/
npm run serve	Preview your build locally, before deploying

(back to top)

Personalization Configuration

• .env
• app.html
• site.js
• rss.xml.js ( language & description )
• slug.svelte ( year )
  • year.svelte

Frontmatter

In content/slug.md

---
title: Title of the Post
date: 2021-09-07
updatedOn: 2022-07-04
isPrivate: true
prev: foo
next: bar
---

title and date are required for all posts.

(back to top)

Environment variables

In .env

PUBLIC_DOMAIN="example.com"
PUBLIC_SITE_URL="https://example.com"

# Sentry
SECRET_SENTRY_KEY="123456"
SECRET_SENTRY_ORG_ID="9876543"
SECRET_SENTRY_PROJECT_ID="01234567891bcdef0123456789abcd"

(back to top)

Tech Stack

• Framework: SvelteKit ( Changelog )
• Styling: Dart Sass, Open Props and PostCSS
• Content: Plain text files w/ MDsveX (markdown preprocessor)
• Code syntax highlighter: Shiki
• Git hooks manager: Lefthook ( configuration )
• Deployment: Firebase Hosting ( docs / configuration )
• Typefaces:
  • Gowun Batang(고운바탕) by Yanghee Ryu
  • Iansui by Fontworks and But Ko
  • Lotion by nina belikova
• Linting & Formatting:
  • accessibility: Pa11y CI ( configuration )
  • credentials: Secretlint ( configuration )
  • plain text files:
    • CSpell ( configuration, words )
    • Vale ( configuration )
      • Alex ( configuration )
  • programming languages:
    • dprint ( configuration )
    • CSS / SCSS: Stylelint ( configuration )
    • JavaScript / TypeScript: ESLint ( configuration )
    • Svelte: svelte-check

(back to top)

📌 TODOs

• prev/next page
• privacy page
• tab or space
• testing
• shelf
• partial hydration

not in 📝

• Dark mode
• Comments / Webmentions
• SEO
• PWA + Service Worker + Offline

(back to top)

Inspiration & Thanks

Props to mvasigh/sveltekit-mdsvex-blog, which this repo was originally based on.

(back to top)

License

This project is licensed under the Beerware License, but all contents copyright (articles, images, videos and visual design) belong to their respective owners or authors.

• error page:
  • img/canvas: Icecream Cat by @chococat