npm - twynejs - Versions diffs - 1.0.0 - Mend

twynejs 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (8) hide show

package/README.md ADDED Viewed

@@ -0,0 +1,3 @@
+# Twine
+a github pages working ssg

package/dist/index.d.ts ADDED Viewed

@@ -0,0 +1,180 @@
+import type { Plugin } from "vite";
+export type { HtmlValue } from "./jsx-runtime.js";
+export interface PagesPluginOptions {
+    /**
+     * Directory containing the page modules (one `.ts`/`.tsx` file per page).
+     *
+     * @default "pages"
+     */
+    pagesDir?: string;
+    /**
+     * Directory for the Markdown files
+     *
+     * @default "docs"
+     */
+    docsDir?: string;
+    /**
+     * File extensions that count as a page.
+     *
+     * @default [".ts", ".tsx", ".js", ".jsx"]
+     */
+    extensions?: string[];
+    /**
+     * Name of the global the shared entry reads to know which page to
+     * render, e.g. `"PAGE_ID"` → `window.PAGE_ID`.
+     *
+     * @default "PAGE_ID"
+     */
+    globalVar?: string;
+    /**
+     * Emit `<id>/index.html` instead of `<id>.html` (pretty / extensionless
+     * URLs). The page with id `"index"` is always emitted as the top-level
+     * `index.html`, never `index/index.html`.
+     *
+     * @default false
+     */
+    prettyUrls?: boolean;
+    /**
+     * Per-page `<title>`. Receives the page id (e.g. `"guide/install"`).
+     *
+     * @default (id) => id
+     */
+    title?: (id: string) => string;
+    /**
+     * Extra HTML to inject into the `<head>` of every emitted page — e.g.
+     * favicon links, `<meta name="description">`, Open Graph tags, …
+     *
+     * Can be:
+     *
+     * - a static string applied to every page
+     * - a record mapping page id → head HTML (missing ids get nothing)
+     * - a function receiving the page id → head HTML
+     *
+     * The result is inserted as-is (raw HTML) into the page shell right
+     * after the style tags, both in the default template and in custom
+     * `template` implementations via `ctx.head`.
+     *
+     * @default ""
+     */
+    head?: string | Record<string, string> | ((id: string) => string);
+    /**
+     * Wrap/replace the emitted HTML shell entirely. Receives the computed
+     * script/style tags and page metadata; must return a full HTML document.
+     * Falls back to a minimal built-in template.
+     */
+    template?: (ctx: PageRenderContext) => string;
+    /** Minify emitted HTML with html-minifier-terser. @default false */
+    minify?: boolean;
+    /**
+     * Remove `console.log` / `console.warn` / `console.error` / `console.debug`
+     * / `console.info` calls from all built page scripts (production only).
+     *
+     * @default false
+     */
+    removeConsole?: boolean;
+    /**
+     * Write a `pages.d.ts` ambient module declaration next to `vite.config.ts`
+     * so `import { pages } from "virtual:pages"` is typed in consumers.
+     *
+     * @default true
+     */
+    dts?: boolean;
+    /**
+     * Where to write the ambient `pages.d.ts` declaration (relative to
+     * `config.root`). Ignored when `dts` is `false`.
+     *
+     * @default "src/pages.d.ts"
+     */
+    dtsPath?: string;
+    /** Skip a file (by page id) from becoming a page. Default: ids starting with "_". */
+    ignore?: (id: string) => boolean;
+    /**
+     * Path (relative to `root`) of the shared client entry, e.g. `"src/index.ts"`.
+     * Only used to serve pages during `vite dev` — production builds get the
+     * bundled entry automatically from Rollup's output. Required for the dev
+     * server route to work; dev falls back to a 404 passthrough if omitted.
+     */
+    entry?: string;
+    /**
+     * Additional CSS files per page route.
+     *
+     * Example:
+     *
+     * {
+     *   "viewer/index": ["./pages/viewer/style.css"],
+     *   "getting-started": ["./docs/docs.css"]
+     * }
+     */
+    styles?: Record<string, string[]>;
+    /**
+     * If the raw Markown should be included in the build,
+     * for example for better search result
+     *
+     * @default false
+     */
+    addRawMarkdown?: boolean;
+    /**
+     * Set the paths to relative paths
+     *
+     * @default false
+     */
+    relativePaths?: boolean;
+    /**
+     * Bundle all pages into a single JS file.
+     *
+     * @default false
+     */
+    singleBundle?: boolean;
+    /**
+     * More detailed output
+     *
+     * @default false
+     */
+    verbose?: boolean;
+    /**
+     * Put each compiled Markdown page into its own dynamically loaded chunk
+     * instead of embedding all Markdown HTML into the main bundle.
+     *
+     * @default false
+     */
+    splitMarkdown?: boolean;
+    /**
+     * Ignored Pathnames
+     *
+     * @default ["/@", "/node_modules/", "/src/"]
+     */
+    ignoredPathnames?: string[];
+    /**
+     * Liquid Template root folder
+     *
+     * @default "src/templates"
+     */
+    liquidTemplateRoot?: string;
+    /**
+     * Module specifier injected into every `.tsx` page so the JSX factory
+     * (`jsx`/`Fragment`) is available. Defaults to the jsx-runtime shipped
+     * with this package.
+     *
+     * @default "twynejs/jsx-runtime"
+     */
+    jsxRuntimePath?: string;
+}
+export interface PageRenderContext {
+    id: string;
+    title: string;
+    globalVar: string;
+    scriptTag: string;
+    styleTag: string;
+    /**
+     * Extra `<head>` HTML (favicon, meta description, …) computed from the
+     * plugin's `head` option for the current page. Insert it into the
+     * `<head>` of a custom `template`.
+     */
+    head: string;
+    /**
+     * Pre-rendered body content (e.g. Liquid pages). When set, the template
+     * renders it as-is instead of bootstrapping the client app.
+     */
+    content?: string;
+}
+export declare function pagesPlugin(options?: PagesPluginOptions): Plugin;