Install
Install Tipnote from npm in three steps. No account or key.
- Install the package in your site’s folder:
npm 7 or later also installs the peer packages it needs (React, Kumo and Phosphor icons), which an EmDash site already has.npm i @zachristudio/tipnote - Register it in
astro.config.mjs, insideemdash():import { defineConfig } from "astro/config"; import react from "@astrojs/react"; import emdash from "emdash/astro"; import { tipnotePlugin } from "@zachristudio/tipnote"; export default defineConfig({ integrations: [ react(), emdash({ // your database and storage settings plugins: [tipnotePlugin()], }), ], }); - Restart or redeploy. Tipnote appears in the admin sidebar. Add your first tip link, then type
/tipnotein a post. See Using Tipnote.
From the EmDash registry
Searching the registry for “tip jar” or “tips” finds Tipnote: Tip Jar & Support Block. That entry is a setup guide. Installing it adds a Tipnote setup page to your admin with these same steps. Tipnote itself always comes from npm, because only a trusted plugin can draw a block on your public pages. You can uninstall the guide once Tipnote is running.
Your templates
The block appears wherever your templates render post content with EmDash’s <PortableText> component, as the default templates do. A template that renders content some other way won’t show it.
Hosting
Nothing extra to configure: the package is public, so every host installs it like any other dependency. Commit package.json and your lockfile, then deploy as usual.
Updating
npm install @zachristudio/tipnote@latest
Then redeploy. Your tip links, settings, blocks and click stats carry over. Check the changelog first.