Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,12 @@
# Potluck Docs — monorepo
# Potluck Docs

The home of Potluck Docs, EkLine's recommended [Astro](https://astro.build/) +
[Starlight](https://starlight.astro.build/) documentation template.
Potluck Docs is an open-source [Astro](https://astro.build/) +
[Starlight](https://starlight.astro.build/) documentation template — interactive
OpenAPI references, private docs behind your SSO, and `llms.txt` built in.
Maintained by EkLine.

This repository is the monorepo that holds it, alongside the sites EkLine hosts
on top of it.

## Are you here to build a docs site?

Expand Down
24 changes: 21 additions & 3 deletions apps/docs/src/content/docs/index.mdx
Original file line number Diff line number Diff line change
@@ -1,9 +1,27 @@
---
title: Potluck Docs
description: An Astro + Starlight documentation site template with theming, interactive API references, and an optional logged-in tier, pre-wired so you can focus on writing.
# Starlight builds `<title>` as `${title} | ${site title}` with no special case
# for the two being equal (utils/head.ts), and this site's title is already
# "Potluck Docs" — so naming this page "Potluck Docs" spent the strongest
# on-page signal saying one opaque word twice. Naming it for the category
# instead yields "Astro + Starlight documentation template | Potluck Docs".
# This is not the visible heading: `hero.title` below is, and it still reads
# "Potluck Docs".
title: Astro + Starlight documentation template
description: Potluck Docs is an open-source Astro + Starlight documentation template — interactive OpenAPI references, private docs behind your SSO, llms.txt built in.
template: splash
# `og:title` is the page title with no site title appended, so the change above
# would have taken the product name off every social card. Starlight's
# `mergeHead` drops its own default when a page supplies a meta tag matching on
# `property`, so this puts it back.
head:
- tag: meta
attrs:
property: og:title
content: Potluck Docs
hero:
tagline: An Astro + Starlight docs site with theming, interactive API references, and an optional logged-in tier already wired up. Fork it, write your content, ship.
# Without this, the heading would inherit the SEO title above.
title: Potluck Docs
tagline: An open-source Astro + Starlight docs site with interactive OpenAPI references, private and per-org docs behind your SSO, and llms.txt already wired up. Fork it, write your content, ship.
actions:
- text: Get started
link: /quickstart/
Expand Down
Loading