Skip to content

Memos Embed — Type‑safe memo card embeds for usememos.com with a ready‑to‑deploy site plus React and Web Component packages.

Notifications You must be signed in to change notification settings

markbang/memos-embed

Repository files navigation

Memos Embed Logo

Memos Embed

CI npm

Embeddable memo cards for Memos, delivered as a website and npm packages.

Workspace Layout

  • apps/site: TanStack Start website (docs, playground, iframe embeds)
  • packages/memos-embed: core API + SSR HTML helpers
  • packages/memos-embed-react: React component wrapper
  • packages/memos-embed-wc: Web Component wrapper

Quick Start

pnpm install
pnpm dev

Build

pnpm -r build

Tests

pnpm test

Usage

Core package

import { fetchMemo, renderMemoHtmlSnippet } from 'memos-embed'

const memo = await fetchMemo({
  baseUrl: 'https://demo.usememos.com/api/v1',
  memoId: '1',
})

const html = renderMemoHtmlSnippet(memo, { includeStyles: true })

React

import { MemoEmbed } from '@memos-embed/react'

<MemoEmbed baseUrl="https://demo.usememos.com/api/v1" memoId="1" />

Web Component

<script type="module" src="https://unpkg.com/@memos-embed/wc@latest/dist/register.js"></script>
<memos-embed base-url="https://demo.usememos.com/api/v1" memo-id="1"></memos-embed>

Iframe

<iframe
  src="https://your-site.com/embed/1?baseUrl=https%3A%2F%2Fdemo.usememos.com%2Fapi%2Fv1"
  style="width: 100%; height: 240px; border: none;"
  title="memos-embed"
></iframe>

About

Memos Embed — Type‑safe memo card embeds for usememos.com with a ready‑to‑deploy site plus React and Web Component packages.

Topics

Resources

Stars

Watchers

Forks