create-riebeckite 0.0.17 → 0.0.18

package/templates/scaffold/presets/starter/app/routes/_renderer.tsx

@@ -0,0 +1,69 @@
+import type { PluginHeadTag } from "@riebeckite/core";
+import { jsxRenderer } from "hono/jsx-renderer";
+import { Link, Script } from "honox/server";
+import { ColorModeScript } from "@riebeckite/plugin-color-mode";
+import { SearchBar } from "@riebeckite/plugin-search";
+import { resolveSiteNavigation } from "@riebeckite/plugin-navigation";
+import { SiteFooter, SiteHeader } from "../components/site-header";
+import { content } from "../content";
+import { config } from "../config";
+
+function themeAttributes() {
+  const { theme } = config;
+
+  return {
+    ...theme.attributes,
+    "data-theme": theme.colorMode === "system" ? undefined : theme.colorMode,
+    "data-theme-name": theme.name,
+    "data-typography": theme.typography,
+    "data-article-layout": theme.articleLayout,
+  };
+}
+
+// Riebeckite plugin client entries need the HonoX client bundle even without
+// an island component.
+export const __importing_islands = true;
+
+export default jsxRenderer(async ({ children }, c) => {
+  const headTags: readonly PluginHeadTag[] = c.get("headTags") ?? [];
+  const navigation = resolveSiteNavigation(config, await content.getManifest(), c.get("htmlLanguage")) ?? { primary: [], secondary: [] };
+
+  return (
+    <html
+      lang={c.get("htmlLanguage") ?? config.site.locale}
+      {...themeAttributes()}
+    >
+      <head>
+        <meta charset="utf-8" />
+        <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+        <title>{config.site.title}</title>
+        <link rel="icon" href="/favicon.ico" />
+        <ColorModeScript />
+        <Link href="/app/style.css" rel="stylesheet" />
+        {headTags.map(renderHeadTag)}
+        <Script src="/app/client.ts" async />
+      </head>
+      <body class="riebeckite-page rb-site">
+         <SiteHeader path={c.req.path} items={navigation.primary} />
+        <SearchBar />
+        {children}
+        <SiteFooter path={c.req.path} items={navigation.secondary} />
+      </body>
+    </html>
+  );
+});
+
+function renderHeadTag(tag: PluginHeadTag, index: number) {
+  const key = `${tag.tag}-${index}`;
+  if (tag.tag === "meta") return <meta {...tag.attrs} key={key} />;
+  if (tag.tag === "link") return <link {...tag.attrs} key={key} />;
+  return (
+    <script
+      {...tag.attrs}
+      key={key}
+      dangerouslySetInnerHTML={
+        tag.children ? { __html: tag.children } : undefined
+      }
+    />
+  );
+}

package/templates/scaffold/presets/starter/app/routes/index.tsx

@@ -0,0 +1,37 @@
+import { getEntryLanguage } from "@riebeckite/core";
+import { createRoute } from "honox/factory";
+import { RecentPosts, getRecentPosts } from "@riebeckite/plugin-recent-posts";
+import { extractTableOfContents, TableOfContents } from "@riebeckite/plugin-toc";
+import { SiteArticle } from "../components/article";
+import { config } from "../config";
+import { content } from "../content";
+
+export default createRoute(async (c) => {
+  const manifest = await content.getManifest();
+  const indexEntry = manifest.bySlug.get("index");
+  if (indexEntry && indexEntry.permalink !== "/") {
+    return c.redirect(indexEntry.permalink, 308);
+  }
+
+  const post = await content.getProcessedContent("index");
+  if (indexEntry?.publishing?.routable === false) {
+    return c.notFound();
+  }
+
+  const recentPosts = await getRecentPosts({ posts: manifest.discoverableEntries, config, getProcessedContent: (slug) => content.getProcessedContent(slug), resolveTitle: (slug, title) => typeof title === "string" && title.trim() ? title : slug.split("/").at(-1) ?? slug });
+  const tableOfContents = extractTableOfContents(post.html ?? "");
+
+  if (indexEntry) {
+    c.set("htmlLanguage", getEntryLanguage(indexEntry));
+    c.set("headTags", indexEntry.headTags ?? []);
+  }
+
+  return c.render(
+    <SiteArticle
+      post={post}
+        bodySlots={indexEntry?.bodySlots}
+        asideContent={<TableOfContents className="table-of-contents--desktop" items={tableOfContents} />}
+        afterContent={<><RecentPosts posts={recentPosts} /></>}
+    />,
+  );
+});

package/templates/scaffold/presets/starter/app/style.css

@@ -0,0 +1,227 @@
+@import "./.riebeckite/plugin-styles.css";
+@import "./.riebeckite/theme-styles.css";
+
+*,
+*::before,
+*::after {
+  box-sizing: border-box;
+}
+
+body {
+  margin: 0;
+  font-family: system-ui, sans-serif;
+}
+
+.riebeckite-page {
+  display: flex;
+  min-height: 100vh;
+  width: 100%;
+  flex-direction: column;
+  align-items: center;
+  padding-block: var(--rb-space-8, 4rem);
+}
+
+.site-header {
+  display: flex;
+  align-items: center;
+  gap: var(--rb-space-3, 1.5rem);
+  padding-block: var(--rb-space-3, 1.5rem);
+  border-bottom: 1px solid var(--rb-color-border);
+}
+
+.site-header,
+.rb-site-footer {
+  width: min(100% - 2rem, var(--rb-layout-article-max, 48rem));
+}
+
+.site-header__home {
+  display: inline-flex;
+  align-items: center;
+  gap: 0.5rem;
+  margin-right: auto;
+  color: var(--rb-color-ink);
+  font-weight: 700;
+  text-decoration: none;
+}
+
+.rb-nav {
+  color: var(--rb-color-ink);
+}
+
+.rb-nav__list {
+  display: flex;
+  align-items: center;
+  gap: var(--rb-space-3, 1.5rem);
+  margin: 0;
+  padding: 0;
+  list-style: none;
+}
+
+.rb-nav__item {
+  position: relative;
+}
+
+.rb-nav__link {
+  color: inherit;
+  text-decoration: none;
+}
+
+.rb-nav__link:hover,
+.rb-nav__link:focus-visible,
+.rb-nav__link--active {
+  color: var(--rb-color-accent);
+}
+
+.rb-nav__link:focus-visible,
+.rb-nav__toggle:focus-visible {
+  outline: 2px solid var(--rb-color-accent);
+  outline-offset: 2px;
+}
+
+.rb-nav__children {
+  display: none;
+  position: absolute;
+  top: 100%;
+  left: 0;
+  min-width: max-content;
+  padding: var(--rb-space-2, 1rem);
+  background: var(--rb-color-surface);
+  border: 1px solid var(--rb-color-border);
+}
+
+.rb-nav__item:hover > .rb-nav__children,
+.rb-nav__item:focus-within > .rb-nav__children {
+  display: flex;
+  flex-direction: column;
+  align-items: stretch;
+}
+
+.rb-nav__mobile {
+  display: none;
+}
+
+.rb-site-footer {
+  margin-top: 1rem;
+  padding-block: var(--rb-space-4, 2rem);
+  border-top: 1px solid var(--rb-color-border);
+}
+
+@media (max-width: 48rem) {
+  .riebeckite-page {
+    padding-block: var(--rb-space-3, 1.5rem);
+  }
+
+  .rb-site-header {
+    flex-wrap: wrap;
+  }
+
+  .rb-site-header > .rb-nav {
+    display: none;
+  }
+
+  .rb-nav__mobile {
+    position: relative;
+    display: block;
+  }
+
+  .rb-nav__mobile > .rb-nav {
+    position: absolute;
+    z-index: 10;
+    top: calc(100% + var(--rb-space-2, 1rem));
+    right: 0;
+    min-width: 12rem;
+    padding: var(--rb-space-3, 1.5rem);
+    background: var(--rb-color-surface);
+    border: 1px solid var(--rb-color-border);
+    box-shadow: 0 4px 12px
+      color-mix(in oklab, var(--rb-color-ink) 14%, transparent);
+  }
+
+  .rb-nav__mobile .rb-nav__list,
+  .rb-nav__mobile .rb-nav__children {
+    display: flex;
+    flex-direction: column;
+    align-items: flex-start;
+    gap: var(--rb-space-2, 1rem);
+  }
+
+  .rb-nav__mobile .rb-nav__list {
+    padding: 0;
+  }
+
+  .rb-nav__mobile .rb-nav__children {
+    position: static;
+    margin-top: var(--rb-space-2, 1rem);
+    padding: 0;
+    background: transparent;
+    border: 0;
+  }
+}
+
+.site-header__logo {
+  width: 1.75rem;
+  height: 1.75rem;
+  object-fit: contain;
+}
+
+.site-article {
+  display: block;
+  width: min(100% - 2rem, var(--rb-layout-article-max, 48rem));
+  padding-block: 2rem;
+  margin: 0 auto;
+}
+
+.rb-article-layout {
+  display: grid;
+  grid-template-columns: minmax(0, var(--rb-layout-article-max, 48rem));
+  justify-content: center;
+  gap: var(--rb-layout-gap, 2rem);
+}
+
+.rb-article-body {
+  min-width: 0;
+  padding-inline: var(--rb-space-2, 1rem);
+}
+
+.site-article__aside {
+  display: none;
+}
+
+.site-article__footer {
+  min-width: 0;
+}
+
+@media (min-width: 88rem) {
+  :is(:root, .rb-theme-root)[data-article-layout="article"] .rb-article-layout {
+    grid-template-columns: minmax(0, var(--rb-layout-article-max, 48rem));
+    position: relative;
+  }
+
+  :is(:root, .rb-theme-root)[data-article-layout="article"] .rb-article-body {
+    grid-column: 1;
+    grid-row: 1;
+  }
+
+  :is(:root, .rb-theme-root)[data-article-layout="article"] .site-article__footer {
+    grid-column: 1;
+  }
+
+  :is(:root, .rb-theme-root)[data-article-layout="article"] .site-article__aside {
+    display: block;
+    grid-column: 1;
+    grid-row: 1;
+    position: sticky;
+    top: 4rem;
+    align-self: start;
+    width: var(--rb-layout-sidebar, 14rem);
+    max-height: calc(100dvh - 8rem);
+    margin-inline-start: calc(
+      -1 * var(--rb-layout-sidebar, 14rem) -
+      var(--rb-layout-gap, 2rem)
+    );
+    overflow: auto;
+    padding-inline-end: 1rem;
+    border-inline-end: 1px solid
+      color-mix(in oklab, currentColor 18%, transparent);
+  }
+}

package/templates/scaffold/presets/starter/content/guide.en.md

@@ -0,0 +1,60 @@
+---
+publish: true
+---
+
+# Getting started
+
+This site was generated from a Riebeckite scaffold preset.
+Everything below lives in this repository, ready to edit.
+
+## Run the site
+
+```sh
+npm install
+npm exec riebeckite dev
+```
+
+
+Open the URL printed in the terminal. The page reloads every time
+you save a Markdown file.
+
+## Add a page
+
+Create `content/hello.md`:
+
+```md
+---
+publish: true
+---
+
+# Hello
+
+This is my second page.
+```
+
+
+The dev server serves it at `/hello`.
+
+## Link the pages
+
+Write `[[hello]]` anywhere and it becomes a link to that page.
+
+## Translate a page
+
+Copy a file next to the original with the language suffix, for
+example `hello.ja.md`. The language switcher picks it up.
+
+## Build
+
+```sh
+npm exec riebeckite build
+```
+
+
+The static site is written to `dist/`.
+
+## Extend
+
+Plugins and themes are registered in `riebeckite.config.ts`.
+Install a package, import its factory, and add it to the `plugins`
+array, or point `theme` at a new theme factory.

package/templates/scaffold/presets/starter/content/index.de.md

@@ -0,0 +1,19 @@
+---
+publish: true
+---
+
+# {{title}}
+
+Willkommen auf deiner Riebeckite-Seite.
+
+Diese Seite stammt aus `content/index.md`. Öffne die Datei, ändere sie und speichere — der Browser aktualisiert sich beim Schreiben.
+
+## Diese Seite bearbeiten
+Inhalte liegen als einfaches Markdown in `content/`. Füge eine Datei hinzu, setze `publish: true` ins Frontmatter, und sie erscheint in der gebauten Seite.
+
+Verbinde Seiten mit einem WikiLink, zum Beispiel `[[guide]]`.
+
+## Weiter erkunden
+
+- [Getting started](/guide)
+- [[examples]]

package/templates/scaffold/presets/starter/content/index.en.md

@@ -0,0 +1,19 @@
+---
+publish: true
+---
+
+# {{title}}
+
+Welcome to your Riebeckite site.
+
+This page is `content/index.md`. Open that file, change it, and save — the browser updates while you write.
+
+## Edit this site
+Content lives in `content/` as plain Markdown. Add a file, give it `publish: true` in the frontmatter, and it appears in the built site.
+
+Link pages with a WikiLink, for example `[[guide]]`.
+
+## Explore
+
+- [Getting started](/guide)
+- [[examples]]

package/templates/scaffold/presets/starter/content/index.es.md

@@ -0,0 +1,19 @@
+---
+publish: true
+---
+
+# {{title}}
+
+Bienvenido a tu sitio Riebeckite.
+
+Esta página viene de `content/index.md`. Abre ese archivo, edítalo y guarda: el navegador se actualiza mientras escribes.
+
+## Editar este sitio
+El contenido vive en `content/` como Markdown simple. Añade un archivo, pon `publish: true` en el frontmatter y aparecerá en el sitio compilado.
+
+Enlaza páginas con un WikiLink, por ejemplo `[[guide]]`.
+
+## Explorar
+
+- [Getting started](/guide)
+- [[examples]]

package/templates/scaffold/presets/starter/content/index.fr.md

@@ -0,0 +1,19 @@
+---
+publish: true
+---
+
+# {{title}}
+
+Bienvenue sur votre site Riebeckite.
+
+Cette page provient de `content/index.md`. Ouvrez ce fichier, modifiez-le et enregistrez — le navigateur se met à jour pendant que vous écrivez.
+
+## Éditer ce site
+Le contenu vit dans `content/` en Markdown simple. Ajoutez un fichier, donnez-lui `publish: true` dans le frontmatter, et il apparaîtra dans le site construit.
+
+Reliez les pages avec un WikiLink, par exemple `[[guide]]`.
+
+## Explorer
+
+- [Getting started](/guide)
+- [[examples]]

package/templates/scaffold/presets/starter/content/index.ja.md

@@ -0,0 +1,19 @@
+---
+publish: true
+---
+
+# {{title}}
+
+あなたの Riebeckite サイトへようこそ。
+
+このページは `content/index.md` です。ファイルを開いて書き換えると、書いている途中でもブラウザの表示が更新されます。
+
+## サイトの編集
+コンテンツは `content/` にプレーンな Markdown として置きます。ファイルを追加してフロントマターに `publish: true` を書けば、ビルドされたサイトに反映されます。
+
+ページ同士は WikiLink でリンクできます（例：`[[guide]]`）。
+
+## さらに深く
+
+- [Getting started](/guide)
+- [[examples]]

package/templates/scaffold/presets/starter/content/index.ko.md

@@ -0,0 +1,19 @@
+---
+publish: true
+---
+
+# {{title}}
+
+Riebeckite 사이트에 오신 것을 환영합니다.
+
+이 페이지는 `content/index.md`에서 만들어집니다. 그 파일을 열어 수정하고 저장하면 글을 쓰는 동안 브라우저가 갱신됩니다.
+
+## 사이트 편집
+콘텐츠는 `content/`에 일반 Markdown으로 저장됩니다. 파일을 추가하고 프론트매터에 `publish: true`를 쓰면 빌드된 사이트에 나타납니다.
+
+WikiLink로 페이지를 연결하세요. 예: `[[guide]]`.
+
+## 더 살펴보기
+
+- [Getting started](/guide)
+- [[examples]]

package/templates/scaffold/presets/starter/content/index.zh-CN.md

@@ -0,0 +1,19 @@
+---
+publish: true
+---
+
+# {{title}}
+
+欢迎来到你的 Riebeckite 站点。
+
+这个页面来自 `content/index.md`。打开这个文件修改并保存，浏览器会随你的输入更新。
+
+## 编辑本站点
+内容以纯 Markdown 存于 `content/`。新建文件并在 frontmatter 中写入 `publish: true`，它就会出现在构建后的站点中。
+
+用 WikiLink 连接页面，例如 `[[guide]]`。
+
+## 继续探索
+
+- [Getting started](/guide)
+- [[examples]]

package/templates/scaffold/presets/starter/content/notes/planning.md

@@ -0,0 +1,16 @@
+---
+title: Planning a Markdown site
+description: A related note used by the generated discovery examples.
+date: 2026-09-30
+tags: [riebeckite, project]
+status: active
+aliases: [/start-here/]
+series: publish-a-site
+series_title: Publish a site
+series_order: 1
+publish: true
+---
+
+# Planning a Markdown site
+
+Start with [[writing]] to see backlinks, related posts, tags, and the series navigation working together.

package/templates/scaffold/presets/starter/content/notes/writing.md

@@ -0,0 +1,15 @@
+---
+title: Writing the first note
+description: A second connected note for search and related-content examples.
+date: 2026-10-01
+tags: [riebeckite, project]
+status: active
+series: publish-a-site
+series_title: Publish a site
+series_order: 2
+publish: true
+---
+
+# Writing the first note
+
+This note links back to [[planning]]. Search for **Markdown site** or browse the generated tags.