npm - @staticbolt/docs - Versions diffs - 0.0.1-beta.3 → 0.0.1-beta.5 - Mend

@staticbolt/docs 0.0.1-beta.3 → 0.0.1-beta.5

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 (117) hide show

package/README.md CHANGED Viewed

@@ -33,7 +33,7 @@ export default defineConfig({
     }),
     plugins.htmlLayoutPlugin({ tags: ["layout", "part", "icon"] }),
-    theme.HtmlCodeBlockPlugin({ rehypeExpressiveCodeOptions }),
+    theme.htmlCodeBlockPlugin({ rehypeExpressiveCodeOptions }),
     theme.katexFontsPlugin(),
     theme.pagefindPlugin(),
     theme.llmsPlugin({ siteUrl: "https://example.com" }),
@@ -90,12 +90,8 @@ Copy this as `sources/layouts/document.layout.html` and edit the names:
   </head>
   <body>
-    <part
-      maxHeading="{{ $data.maxHeading ?? 3 }}"
-      minHeading="{{ $data.minHeading ?? 2 }}"
-      src="@staticbolt/docs/parts/document/document.part.html"
-      title="My Project"
-    >
+    <part inherit src="@staticbolt/docs/parts/document/document.part.html" title="My Project">
+      <slot name="sidebar" slot="sidebar"></slot>
       <part slot="icons" src="@parts/social-icons/social-icons.part.html"></part>
       <slot />
     </part>
@@ -107,17 +103,17 @@ Copy this as `sources/layouts/document.layout.html` and edit the names:
 To change the page structure, copy `node_modules/@staticbolt/docs/sources/parts/document/document.part.html` into the project and point the layout at the copy; it references the other parts by package path, so it works as is.
-| Part                  | Role                                                                                         |
-| --------------------- | -------------------------------------------------------------------------------------------- |
-| `document`            | The whole page. `title`, `minHeading`, `maxHeading`, `mermaid`, slot `icons`, default slot.  |
-| `header`              | Takes `title`. Slot `icons` for the social links.                                            |
-| `sidebar`             | Filled by `contentPlugin`. Slot `icons` for the social links.                                |
-| `table-of-content`    | `-desktop` takes `minHeading` and `maxHeading`, `-mobile` none.                              |
-| `pagination-links`    | Previous/next links read from the sidebar.                                                   |
-| `callouts`            | Build-time script turning collapsible callouts into accordions.                              |
-| `mermaid`             | Renders ` ```mermaid ` fences. Removes itself from pages without. Needs `mermaid` installed. |
-| `color-scheme-switch` | Already inside header and sidebar.                                                           |
-| `badge`               | Used by the sidebar for `data.badgeText` / `data.badgeVariant`.                              |
+| Part                  | Role                                                                                                                         |
+| --------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
+| `document`            | The whole page. `title`, `minHeading`, `maxHeading`, `mermaid`, slots `sidebar` and `icons`, default slot.                   |
+| `header`              | Takes `title`. Slot `icons` for the social links.                                                                            |
+| `sidebar`             | Default slot for the tree, filled by `contentPlugin` through the layout's `sidebar` slot. Slot `icons` for the social links. |
+| `table-of-content`    | `-desktop` takes `minHeading` and `maxHeading`, `-mobile` none.                                                              |
+| `pagination-links`    | Previous/next links read from the sidebar.                                                                                   |
+| `callouts`            | Build-time script turning collapsible callouts into accordions.                                                              |
+| `mermaid`             | Renders ` ```mermaid ` fences. Removes itself from pages without.                                                            |
+| `color-scheme-switch` | Already inside header and sidebar.                                                                                           |
+| `badge`               | Used by the sidebar for `data.badgeText` / `data.badgeVariant`.                                                              |
 ## Styles
@@ -145,4 +141,5 @@ Any `--sb-*` variable from `global.css` can be overridden the same way.
 ## Overriding a part
 Copy it from `node_modules/@staticbolt/docs/sources/parts/` into the project and point the layout at the copy.
-For the sidebar parts pass the copy through `contentPlugin`'s `sidebarLayout`, `directoryLayout`, or `linkLayout`.
+For the folder and link parts pass the copy through `contentPlugin`'s `directoryLayout` or `linkLayout`.
+A layout of your own has to forward the `sidebar` slot down to the sidebar part, as the one above does.

package/lib/index.d.mts CHANGED Viewed

@@ -5,7 +5,6 @@ import { Root } from "hast";
 import { LanguageRegistration } from "shiki";
 import { Plugin as Plugin$1 } from "unified";
 import { Root as Root$1 } from "mdast";
-import { Node } from "unist";
 //#region plugins/code-block-plugin.d.ts
 interface HtmlCodeBlockPlugin {
   /**
@@ -21,7 +20,7 @@ interface HtmlCodeBlockPlugin {
  * replaces the tag with a syntax highlighted code block. Use the `lang` attribute to set the language, and the other attributes
  * for the rest of the expressive-code metadata.
  */
-declare function HtmlCodeBlockPlugin(options?: HtmlCodeBlockPlugin): Plugin;
+declare function htmlCodeBlockPlugin(options?: HtmlCodeBlockPlugin): Plugin;
 //#endregion
 //#region plugins/collapsible-plugin.d.ts
 interface CollapsiblePluginOptions {
@@ -161,38 +160,32 @@ interface ContentPluginOptions {
    * @default true
    */
   collapsed?: boolean;
-  /** Defines the layout name/path to be used for markdown files. */
+  /**
+   * Words written as listed in the titles derived from file and directory names, on top of the built-in set (`API`, `CLI`, `CSS`,
+   * `HTML`, `JSON`, `SVG`, `URL`, ...). Whole words only, matched case-insensitively: `cli.md` shows as "CLI", and with `"i18n"`
+   * listed `i18n.md` stays "i18n".
+   *
+   * @example
+   *   ({ acronyms: ["SDK", "OAuth", "i18n", "ESLint"] });
+   */
+  acronyms?: string[];
+  /**
+   * Defines the layout name/path to be used for markdown files.\
+   * The sidebar tree goes into the layout's `sidebar` slot, so every layout listed here has to carry a `<slot name="sidebar">`,
+   * or forward one to the part that does.
+   */
   layouts: {
     default: string;
     [key: string]: string;
   };
-  /** The layout into which the generated sidebar HTML will be injected. */
-  sidebarLayout?: {
-    /**
-     * Path to the layout file.
-     *
-     * @default the theme's `sidebar.part.html`
-     */
-    path?: string;
-    /**
-     * The custom-element tag name used for this layout.
-     *
-     * If omitted, the tag name will be auto extracted from the layout path
-     */
-    tag?: string;
-    /**
-     * The attribute on the layout tag that holds the source path.
-     *
-     * @default "src"
-     */
-    sourceAttribute?: string;
-    /**
-     * The slot name into which the sidebar is inserted.
-     *
-     * @default "sidebar"
-     */
-    slotName?: string;
-  };
+  /**
+   * Key/value pairs added to every page's front matter, so they reach the layout tag as attributes.\
+   * A page's own front matter wins. The keys the plugin consumes itself, `layout`, `publish` and `sidebar.*`, are ignored.
+   *
+   * @example
+   *   ({ data: { version: "2.0", "data-repo": "https://..." } });
+   */
+  data?: Record<string, unknown>;
   /** The layout used to render a collapsible directory node. */
   directoryLayout?: {
     /**
@@ -241,7 +234,8 @@ interface ContentPluginOptions {
 declare function contentPlugin(options: ContentPluginOptions): Plugin;
 //#endregion
 //#region plugins/content-plugin/helpers.d.ts
-declare function normalizeTitle(string: string): string;
+/** Turns a file or directory name into a title: separators to spaces, every word capitalized, listed words as listed. */
+declare function normalizeTitle(string: string, acronyms?: readonly string[]): string;
 //#endregion
 //#region plugins/ec-cache.d.ts
 declare function sha1(input: string): string;
@@ -293,6 +287,25 @@ interface LlmsPluginOptions {
   title?: string;
   /** One-line summary quoted under the heading. */
   summary?: string;
+  /**
+   * Glob patterns for the pages to list.
+   *
+   * @default ["pages/**\/*.md"]
+   */
+  include?: string[];
+  /**
+   * Glob patterns to leave out.
+   *
+   * @default [ ]
+   */
+  exclude?: string[];
+  /**
+   * Path of the pair of files, relative to the output directory and without the extension: `"llms"` writes `llms.txt` and
+   * `llms-full.txt`. Give each plugin a path of its own when a site runs more than one.
+   *
+   * @default "llms"
+   */
+  output?: string;
 }
 /**
  * Writes `llms.txt` and `llms-full.txt`, plus a copy of every page's markdown beside its HTML.
@@ -372,15 +385,29 @@ declare const remarkObsidianTags: Plugin$1<[], Root$1>;
 //#region plugins/pagefind-plugin.d.ts
 interface PagefindPluginOptions {
   /**
-   * Glob, relative to the output directory, selecting the pages to index.
+   * Directory to index, relative to the output directory. Result URLs are relative to it, so the bundle has to sit inside it for
+   * Pagefind to resolve them: `root: "core"` indexes `core/` and writes `core/pagefind/`.
+   *
+   * @default "."
+   */
+  root?: string;
+  /**
+   * Glob, relative to `root`, selecting the pages to index.
    *
    * @default "**\/*.html"
    */
   glob?: string;
+  /**
+   * Directory the index is written to, relative to the output directory. The `pagefind` part's `bundle` attribute has to point at
+   * it.
+   *
+   * @default `${root}/pagefind`
+   */
+  output?: string;
 }
-declare function pagefindPlugin({ glob }?: PagefindPluginOptions): Plugin;
+declare function pagefindPlugin(options?: PagefindPluginOptions): Plugin;
 //#endregion
 //#region plugins/wrap-table.d.ts
-declare function wrapTables(): (tree: Node) => void;
+declare function wrapTables(): (tree: Root) => void;
 //#endregion
-export { CollapsiblePluginOptions, HtmlCodeBlockPlugin, PersistentCache, RemarkObsidianCommentsOptions, cachedRehypeExpressiveCode, contentPlugin, ecCachePlugin, ecCacheSalt, htmlWithTypeScriptScripts, katexFontsPlugin, llmsPlugin, normalizeTitle, pagefindPlugin, pluginCollapsible, rehypeMermaidFence, remarkObsidianComments, remarkObsidianTags, sha1, wrapTables };
+export { CollapsiblePluginOptions, HtmlCodeBlockPlugin, PersistentCache, RemarkObsidianCommentsOptions, cachedRehypeExpressiveCode, contentPlugin, ecCachePlugin, ecCacheSalt, htmlCodeBlockPlugin, htmlWithTypeScriptScripts, katexFontsPlugin, llmsPlugin, normalizeTitle, pagefindPlugin, pluginCollapsible, rehypeMermaidFence, remarkObsidianComments, remarkObsidianTags, sha1, wrapTables };

package/lib/mermaid/abnfDiagram-PAR5IXJI-Ibbj5eGO.js ADDED Viewed

@@ -0,0 +1 @@

+ import{t as e}from"./chunk-AQ6EADP3-CZhslHi-.js";import{q as t}from"./chunk-H7VHZCWX-CwFRFlEn.js";import"./chunk-QJSWEUOL-kvKBktmc.js";import"./chunk-IJBDOHL6-CgcssvZb.js";import{n,r,t as i}from"./chunk-SLDQ463B-D15xTdNW.js";import{t as a}from"./chunk-JQRUD6KW-Dbva2Z17.js";import"./chunk-ZS6VBONO-D-IFTJgn.js";import{n as o}from"./chunk-5IQCK5RY-Df5Ppxew.js";import"./chunk-JZGDI5JK-BspJQ1vQ.js";import"./chunk-OJINMHTS-rKnCIFV0.js";import"./chunk-VQC2EELJ-sGo2yn97.js";import"./chunk-KD6SPIPN-4bKl37hM.js";import"./chunk-Q6NGPIAH-CM9NYxWM.js";import{n as s}from"./chunk-RT4MAWR3-Cv_8LyN5.js";import"./chunk-YBMQ5JGJ-DlZ1nCKo.js";import"./chunk-GDY2UAB4-QtXfmDIW.js";import"./chunk-3SMGFRGC-C0WC5bhP.js";import"./chunk-3NPNU5GP-8WYybYAh.js";import"./chunk-TCEHX7R3-BXjgPiQF.js";import"./chunk-5MVFYWFU-DgXg5u6h.js";import"./chunk-SFMINX4W-BW2NSwFJ.js";import"./chunk-JFFVMJIA-Cx1_ZSMR.js";import"./chunk-ZUNWM646-DRKPDcQl.js";var c=s().RailroadAbnf.parser.LangiumParser,l=e(e=>{let t=e.alternatives.map(u);return t.length===1?t[0]:{type:`choice`,alternatives:t}},`transformAlternation`),u=e(e=>{let t=e.elements.map(f);return t.length===1?t[0]:{type:`sequence`,elements:t}},`transformConcatenation`),d=e(e=>{if(e.includes(`*`)){let[t,n]=e.split(`*`);return{min:t?parseInt(t,10):0,max:n?parseInt(n,10):1/0}}let t=parseInt(e,10);return{min:t,max:t}},`parseRepeat`),f=e(e=>{let t=p(e.primary);if(!e.repeat)return t;let{min:n,max:r}=d(e.repeat);return n===0&&r===1?{type:`optional`,element:t}:{type:`repetition`,element:t,min:n,max:r}},`transformElement`),p=e(e=>{switch(e.$type){case`AbnfStringLiteral`:return{type:`terminal`,value:e.value};case`AbnfNumVal`:return{type:`terminal`,value:e.value};case`AbnfRuleName`:return{type:`nonterminal`,name:e.name};case`AbnfGroup`:return l(e.element);case`AbnfOptionalGroup`:return{type:`optional`,element:l(e.element)};default:throw Error(`Unsupported ABNF primary node: ${e.$type}`)}},`transformPrimary`),m=e(e=>({name:e.name,definition:l(e.definition)}),`transformRule`),h=e(e=>{a(e,r),e.title&&r.setTitle(e.title),e.rules.map(e=>r.addRule(m(e)))},`populateDb`),g={parser:{parse:e(e=>{r.clear(),t.debug(`[ABNF Parser] Starting Langium parse`);let n=c.parse(e);if(n.lexerErrors.length>0||n.parserErrors.length>0)throw new o(n);let i=n.value;t.debug(`[ABNF Parser] Parsed rules:`,i.rules.length),h(i),t.debug(`[ABNF Parser] Parse complete`)},`parse`),parser:{yy:r}},db:r,renderer:n,styles:i};export{g as diagram};

package/lib/mermaid/architecture-7GRP2DOG-M7G3SWCO-BJAoKIRD.js ADDED Viewed

	@@ -0,0 +1 @@
1	+ import"./chunk-ZS6VBONO-D-IFTJgn.js";import{t as e}from"./chunk-JFFVMJIA-Cx1_ZSMR.js";export{e as createArchitectureServices};