Skip to content

Configuration

synced/.repos-metadata.json

Written by scripts/sync-docs.ts after each sync. Do not edit manually — it is regenerated on every run.

json
[
  {
    "slug": "dotfiles",
    "title": "Dotfiles",
    "description": "macOS and Debian dotfiles and setup scripts.",
    "repo": "KevinDeBenedetti/dotfiles"
  }
]
FieldDescription
slugRepository name, used as the synced/<slug>/ directory name and URL prefix.
titleHuman-readable title derived from the repository name (kebab-case → Title Case).
descriptionGitHub repository description.
repoFull owner/name slug.

Local project metadata

Locally managed projects (under docs/<slug>/) are discovered automatically when their index.md contains a repo: frontmatter field. Additional fields can be set to control display:

FieldTypeRequiredDescription
repostringYesFull owner/name slug. Presence of this field marks the directory as a local project. Also used to build edit-on-GitHub links.
descriptionstringNoOne-line summary shown on the homepage feature card.
iconstringNoEmoji prepended to the project title in navigation.
ordernumberNoSort position in the nav dropdown and homepage cards. Lower numbers appear first.

Example (docs/docs/index.md frontmatter):

yaml
---
title: Overview
description: Documentation for this documentation hub.
repo: KevinDeBenedetti/kevindebenedetti.github.io
icon: "📖"
order: 0
---

.vitepress/config.ts

Static VitePress configuration. Imports generated values from .vitepress/config.generated.ts.

Key settings:

OptionValue
base/
srcDir. (repo root)
rewritesMaps synced/:slug/* and docs/:slug/*/:slug/*
titleKevin's Docs
themeConfig.navImported from generatedNav
themeConfig.sidebarImported from generatedSidebar
themeConfig.editLinkUses generatedEditLinkPattern to link each page back to its source file on GitHub

.vitepress/config.generated.ts

Auto-generated on every build. Do not edit manually.

Exports:

ExportTypeDescription
generatedNavDefaultTheme.NavItem[]Top navigation items
generatedSidebarDefaultTheme.SidebarMultiSidebar trees keyed by /<slug>/
generatedEditLinkPattern({ filePath }) => stringMaps a page's source path to its edit URL on GitHub

Environment variables

Used by scripts/sync-docs.ts at sync time:

VariableDefaultDescription
GITHUB_TOKEN(empty)Personal access token for the GitHub API. Without it, requests are unauthenticated and rate-limited to 60/hour.
GITHUB_OWNERKevinDeBenedettiGitHub username to fetch repositories for.
GITHUB_API_URLhttps://api.github.comGitHub API base URL. Override for GitHub Enterprise.