diff --git a/README.md b/README.md
index 40d090e..aad05cf 100644
--- a/README.md
+++ b/README.md
@@ -2,7 +2,7 @@
-
+
# entity
diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts
index d0e5de9..79bd324 100644
--- a/docs/.vitepress/config.ts
+++ b/docs/.vitepress/config.ts
@@ -139,7 +139,7 @@ export default defineConfig({
},
themeConfig: {
- logo: { light: "/logo-light.svg", dark: "/logo-dark.svg" },
+ logo: { light: "/logo-light.svg", dark: "/logo-dark.svg", alt: "entity logo" },
nav: [
// The guide is organised by the four Diátaxis modes; the dropdown links
@@ -220,7 +220,7 @@ export default defineConfig({
},
head: [
- ["link", { rel: "icon", type: "image/svg+xml", href: `${BASE}logo.svg` }],
+ ["link", { rel: "icon", type: "image/svg+xml", href: `${BASE}favicon.svg` }],
["meta", { name: "author", content: "Benoit TRAVERS" }],
["meta", { name: "robots", content: "index, follow" }],
["meta", { name: "application-name", content: "entity" }],
@@ -236,16 +236,10 @@ export default defineConfig({
["meta", { property: "og:type", content: "website" }],
["meta", { property: "og:site_name", content: "entity" }],
["meta", { property: "og:locale", content: "en_US" }],
- // The 1280x640 social card, on the same template as the other btravstack
- // packages. SVG is not a valid og:image: X, Slack, LinkedIn and Discord all
- // refuse to render one, which is why pointing this at the logo produced no
- // preview at all rather than a small one.
["meta", { property: "og:image", content: `${SITE_URL}og-entity.png` }],
["meta", { property: "og:image:type", content: "image/png" }],
- // The card's true size. The sibling sites declare 1200x630 (the size the OG
- // docs recommend) while shipping a 1280x640 file; these are measured.
- ["meta", { property: "og:image:width", content: "1280" }],
- ["meta", { property: "og:image:height", content: "640" }],
+ ["meta", { property: "og:image:width", content: "1200" }],
+ ["meta", { property: "og:image:height", content: "630" }],
[
"meta",
{
diff --git a/docs/branding/README.md b/docs/branding/README.md
new file mode 100644
index 0000000..d0e7dd8
--- /dev/null
+++ b/docs/branding/README.md
@@ -0,0 +1,22 @@
+# entity branding
+
+The illustrated mascot is a pink beet at the bottom of an identity-card photo,
+with its hands resting across the lower frame as if ready to climb out. It belongs
+to the shared btravstack beet family. Its editable source is
+[`scripts/generate-brand.mjs`](https://github.com/btravstack/btravstack.github.io/blob/main/scripts/generate-brand.mjs)
+in the website repository. Regenerate there, then copy the project assets from
+`apps/website/public/logos/` into this repository's `docs/public/`:
+
+- `entity-light.svg` → `logo-light.svg` and `logo.svg` (the default).
+- `entity-dark.svg` → `logo-dark.svg`.
+- `entity-mono.svg` → `logo-mono.svg` (grayscale print, retaining the shading).
+- `entity-favicon.svg` → `favicon.svg`.
+
+The README and documentation navigation and hero use the light/dark pair.
+The favicon uses a simplified mascot portrait for legibility at small sizes.
+The social preview is `og-entity.png`, a 1200 × 630 PNG using the same mark.
+Its editable source is the website's
+[`branding/social-card.html`](https://github.com/btravstack/btravstack.github.io/blob/main/branding/social-card.html),
+rendered with `?project=entity`.
+Keep its dimensions in the VitePress metadata in sync when replacing it.
+Assets are committed locally; rendering never fetches branding from another site.
diff --git a/docs/index.md b/docs/index.md
index db76b34..3dc8dbc 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -10,7 +10,7 @@ hero:
image:
light: /logo-light.svg
dark: /logo-dark.svg
- alt: entity
+ alt: entity logo
actions:
- theme: brand
text: Get Started
diff --git a/docs/public/favicon.svg b/docs/public/favicon.svg
new file mode 100644
index 0000000..7a65e7e
--- /dev/null
+++ b/docs/public/favicon.svg
@@ -0,0 +1,17 @@
+
diff --git a/docs/public/logo-dark.svg b/docs/public/logo-dark.svg
index 804ac95..96f40b9 100644
--- a/docs/public/logo-dark.svg
+++ b/docs/public/logo-dark.svg
@@ -1,33 +1,17 @@
-
+
diff --git a/docs/public/logo-light.svg b/docs/public/logo-light.svg
index 30972be..5035726 100644
--- a/docs/public/logo-light.svg
+++ b/docs/public/logo-light.svg
@@ -1,33 +1,17 @@
-
+
diff --git a/docs/public/logo-mono.svg b/docs/public/logo-mono.svg
new file mode 100644
index 0000000..33fd8a4
--- /dev/null
+++ b/docs/public/logo-mono.svg
@@ -0,0 +1,17 @@
+
diff --git a/docs/public/logo.svg b/docs/public/logo.svg
index 4aa0e63..5035726 100644
--- a/docs/public/logo.svg
+++ b/docs/public/logo.svg
@@ -1,18 +1,17 @@
-
+
diff --git a/docs/public/og-entity.png b/docs/public/og-entity.png
index 9f623f5..2f9f4a6 100644
Binary files a/docs/public/og-entity.png and b/docs/public/og-entity.png differ