export interface RepoInfo { /** Short project name, e.g. "roost". */ name: string; /** One-line description, or '' when nothing could be found. */ description: string; /** Canonical https URL of the repository, or '' if not a GitHub remote. */ repoUrl: string; /** Default branch, used to build "edit this page" links. */ defaultBranch: string; } export interface ForRepoOptions { /** Path to the repository the docs are for. */ repoDir: string; /** Where the site was scaffolded. */ siteDir: string; /** Public URL the site will be served from, e.g. https://roosting.dev. */ siteUrl?: string; /** Site directory name relative to the repo root, for edit links. */ siteRelPath: string; /** Emit Dockerfile + nginx.conf. */ deploy: 'docker' | 'none'; /** Keep the recipe's sample blog. */ withBlog: boolean; } /** Normalise any git remote form to an https URL. */ export declare function normalizeRemote(remote: string): string; /** * Learn what we can about the repository. * * Every lookup degrades to a sensible default rather than failing: scaffolding * must work in a directory with no git remote, no `gh`, and no network. */ export declare function detectRepo(repoDir: string): Promise; export declare function renderMetadata(repo: RepoInfo, siteUrl: string): string; export declare function renderStarlightConfig(repo: RepoInfo, siteRelPath: string): string; /** * The starter page. * * Deliberately short and obviously a placeholder: a scaffolder that writes * plausible-looking prose invites shipping text nobody wrote. */ export declare function renderStarterPage(repo: RepoInfo): string; export declare function renderDockerfile(): string; export declare function renderNginxConf(): string; export declare function renderDockerignore(): string; /** * Instructions any coding agent reads before touching the site. * * Harness-agnostic on purpose: it is plain Markdown, so Claude Code, Codex, * opencode and Cursor all work from the same rules instead of each needing * its own plugin. */ export declare function renderAgentsMd(repo: RepoInfo, siteUrl: string, siteRelPath: string): string; /** Apply everything derivable from the repo to a freshly scaffolded site. */ export declare function applyForRepo(options: ForRepoOptions): Promise; //# sourceMappingURL=for-repo.d.ts.map