hyfdev/musubi

A a personal website framework using Notion as a CMS, powered by Void framework and Vue 3.

★ 8Forks 0TypeScriptGitHub ↗Compare

Project website ↗

README

Musubi / 結び

Musubi is a personal website framework. It reads your Notion workspace at build time and publishes a static site to Cloudflare Workers.

  • Fork, then deploy. Fork the repository and connect it to Cloudflare Workers.
  • Write and configure the site in Notion. No need to clone the repository, no local config file.
  • Reads Notion through the official API. Read-only, and only the pages you share with it.
  • Built on Void Framework and Vue 3.
  • Reading-first design derived from Kami.

How it works

Void Framework reads the content from Notion and deploys the built site to Cloudflare Workers.

Local development

Install Vite+, then:

vp install
vpr dev

The dev server runs at http://localhost:5173 and reads a checked-in Notion snapshot, so it needs no Notion token. vpr ready runs the full check and build.

License

Musubi's source code is available under the MIT License. Fonts and the font files a build generates are not.

Tsanger JinKai 02, the default Chinese typeface, is licensed for personal use only. Do not build a commercial site with Musubi as it ships. See Font sources and licenses.

Contributors

hyfdev

Issues