Skip to content

immmmmmmu/perch-oss

Repository files navigation

perch

発信し続ける人のための、生きているプロフィールページ

perch(止まり木)は note・Zenn・YouTube・自社ブログ等の複数チャネルに発信する人が、書き続けるだけで自動的に最新コンテンツが反映されるプロフィールページを作れる OSS ツールキットです。

  • @perch/core — feed fetching, normalization, Markdown rendering, and OGP helpers
  • @perch/cli — self-hosted static profile generator
  • @perch/theme-* — bundled themes for different use cases
  • @perch/i18n — shared ja/en message assets

ステータス

開発中。npm public release に向けて API と package boundary を整理しています。

Theme Direction

For self-hosted pages, editorial is the recommended starting theme: it is designed for writers, consultants, engineers, and teams that want a calm publication-style profile.

Bundled themes are intentionally use-case based:

  • editorial — writing, expertise, and trust
  • minimal — lightweight reading-first page
  • grid — media-rich post gallery
  • timeline — public activity log
  • card — social bio links and latest posts

Live Theme Gallery

All five bundled themes are deployed side-by-side from the same demo content so you can compare layouts before choosing one:

Each demo renders the same examples/profile/perch.config.yaml and Markdown body through a different theme.

Self-hosted Editing Model

For OSS users, the generated project is designed around a simple editing model:

  • change perch.config.yaml for profile text, links, metadata, locale, theme, and feed URLs
  • replace files in public/ for avatar, OGP image, favicon, and other assets
  • run perch build to regenerate dist/

perch new also creates an AGENTS.md file inside the generated profile project. It tells AI agents which files to read first, which files are generated, and how to verify changes.

クイックスタート(開発)

# 前提: Node 22+, pnpm 9+
pnpm install
pnpm typecheck
pnpm lint
pnpm test

各 package / app の起動方法は当該 README を参照。

ライセンス

packages/* は MIT License です。詳細は LICENSE と各 package の LICENSE を参照してください。

コントリビューション

OSS package への PR は歓迎です。

詳細: CONTRIBUTING.md

About

OSS toolkit for living profile pages

Resources

License

Contributing

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors