docs: sync README branding from .github

This commit is contained in:
boojack
2026-10-20 21:15:48 +08:00
parent f0ee2fd448
commit 48259e6022
6 changed files with 17 additions and 23 deletions
+9 -7
View File
@@ -7,9 +7,9 @@
</picture>
</h1>
### Seconds to write. Yours to keep.
### Simple note-taking for your everyday thoughts.
Memos is a place for every quick thought. No title, no folder, nothing to pick: type, and the thought is kept on the day you wrote it. Your memos stay where you decide, yours alone until you share one with family and friends.
Memos is an open-source, self-hosted note-taking app that brings your everyday thoughts together in a personal timeline. Your data stays yours, and you choose what to keep private or share.
[Demo](https://demo.usememos.com) · [Install](#quick-start) · [Docs](https://usememos.com/docs) · [Discord](https://discord.gg/tfPJa4UmAv)
@@ -22,12 +22,14 @@ Memos is a place for every quick thought. No title, no folder, nothing to pick:
<img src="https://raw.githubusercontent.com/usememos/.github/refs/heads/main/assets/previews/timeline-light.png" alt="The Memos timeline with a memo composer and recent memos" />
</picture>
## What you get
## About Memos
- **A place for every quick thought.** Memos asks nothing first: no title to invent, no folder to pick, no place to put it. Type, and the thought is kept before it goes.
- **A day you can return to.** Every memo keeps the day it was written, so any day can be found again: by scrolling, by calendar, by tag, or by word.
- **A record that is yours.** Your memos live where you decide, report to no one, and leave as plain Markdown whenever you like.
- **Family and friends, when you choose.** A memo is yours alone until you share it. Each person writes their own memos and sees only what you choose to show.
Memos is an open-source, self-hosted note-taking app for your everyday thoughts.
- **Everyday writing.** A single sentence can be a whole memo, or you can take your time with a longer entry, using Markdown to give your words more structure.
- **A personal timeline.** Each memo stays with the day you wrote it, bringing your thoughts together in a timeline you can look back through. Tags connect related thoughts across those days, making it easy to pick up a topic again or find something you remember writing.
- **Your own data.** Your record lives on your own server, and your data stays yours.
- **Sharing you control.** You choose what stays private, what to share with family and friends, and what to publish on the web. In shared spaces, you can write alongside others while each person keeps their own memos.
## Quick start
+1 -1
View File
@@ -1,7 +1,7 @@
{
"name": "Memos",
"short_name": "Memos",
"description": "A timeline for your thoughts. Just type. It stays yours.",
"description": "Memos is an open-source, self-hosted note-taking app that brings your everyday thoughts together in a personal timeline. Your data stays yours, and you choose what to keep private or share.",
"icons": [
{ "src": "/android-chrome-192x192.png?v=celadon", "sizes": "192x192", "type": "image/png" },
{ "src": "/android-chrome-512x512.png?v=celadon", "sizes": "512x512", "type": "image/png" }
+1 -1
View File
@@ -7,7 +7,7 @@
"api-docs-note": "REST and gRPC reference",
"build": "Build",
"demo": "Demo",
"description": "Memos is a place for every quick thought. No title, no folder, nothing to pick: type, and the thought is kept on the day you wrote it. Your memos stay where you decide, yours alone until you share one with family and friends.",
"description": "Memos is an open-source, self-hosted note-taking app that brings your everyday thoughts together in a personal timeline. Your data stays yours, and you choose what to keep private or share.",
"distribution": "Distribution",
"documents-note": "Deploy, configure, and use Memos",
"github-repository-note": "Source, issues, and releases",
+1 -1
View File
@@ -22,7 +22,7 @@
"api-docs-note": "REST and gRPC reference",
"build": "Build",
"demo": "Demo",
"description": "Memos is a place for every quick thought. No title, no folder, nothing to pick: type, and the thought is kept on the day you wrote it. Your memos stay where you decide, yours alone until you share one with family and friends.",
"description": "Memos is an open-source, self-hosted note-taking app that brings your everyday thoughts together in a personal timeline. Your data stays yours, and you choose what to keep private or share.",
"distribution": "Distribution",
"documents": "Documents",
"documents-note": "Deploy, configure, and use Memos",
+3 -11
View File
@@ -97,17 +97,9 @@ const About = () => {
</div>
)}
</div>
{/* The tagline sizes to its own column so neither sentence ever breaks mid-line. */}
<div className="@container mt-6">
<p className="text-[length:clamp(1.875rem,13cqi,3.25rem)] leading-[1.15] tracking-tight wrap-anywhere text-foreground">
{customProfile?.description || (
<>
<span className="block whitespace-nowrap">Seconds to write.</span>{" "}
<span className="block whitespace-nowrap">Yours to keep.</span>
</>
)}
</p>
</div>
<p className="mt-6 text-balance text-3xl leading-tight tracking-tight wrap-anywhere text-foreground sm:text-4xl">
{customProfile?.description || "Simple note-taking for your everyday thoughts."}
</p>
<p className="mt-6 max-w-md text-base leading-relaxed text-muted-foreground @min-[60rem]:text-lg">{t("about.description")}</p>
{buildRows.length > 0 && (
+2 -2
View File
@@ -52,7 +52,7 @@ describe("<About>", () => {
expect(screen.getByRole("heading", { name: "Memos" })).toBeInTheDocument();
expect(document.querySelector(".memos-mark")).toHaveAttribute("fill", "currentColor");
expect(document.querySelector(".memos-mark")).toHaveAttribute("height", "48");
expect(screen.getByText(/Seconds to write/i)).toBeInTheDocument();
expect(screen.getByText("Simple note-taking for your everyday thoughts.")).toBeInTheDocument();
expect(screen.getByText("about.description")).toBeInTheDocument();
expect(screen.getByRole("link", { name: /Version\s*v0\.25\.0/ })).toHaveAttribute(
"href",
@@ -144,7 +144,7 @@ describe("<About>", () => {
expect(screen.getByRole("heading", { name: "Team Notes" })).toBeInTheDocument();
expect(screen.getByText("Our shared scratchpad.")).toBeInTheDocument();
expect(screen.queryByText(/Seconds to write/i)).not.toBeInTheDocument();
expect(screen.queryByText("Simple note-taking for your everyday thoughts.")).not.toBeInTheDocument();
expect(document.querySelector("img")).toHaveAttribute("src", "/custom-logo.png");
expect(screen.getByText("Powered by Memos")).toBeInTheDocument();
});