@docpensieve/shared 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Valentin Chevoleau
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,36 @@
+# @docpensieve/shared
+
+> Shared constants, errors and slugs
+
+Part of [DocPensieve](https://github.com/Juniors017/docpensieve), a static documentation site generator:
+Markdown and MDX in, static HTML out, one version per orphan branch, JSON-LD
+structured data from the frontmatter.
+
+## Installation
+
+```bash
+npm install @docpensieve/shared
+```
+
+## Usage
+
+This package depends on nothing: it is the leaf of DocPensieve's dependency
+graph. Anything two or more packages need lives here.
+
+```js
+import { slugify, filePathToSlug, DocPensieveError } from '@docpensieve/shared';
+
+slugify('Crème Brûlée Recipes'); // 'creme-brulee-recipes'
+filePathToSlug('guide/01-install.md'); // 'guide/install'
+```
+
+Accents are stripped from slugs, which keeps URLs readable instead of
+percent-encoded.
+
+## Documentation
+
+See the [repository](https://github.com/Juniors017/docpensieve#readme).
+
+## License
+
+MIT

package/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "@docpensieve/shared",
+  "version": "0.1.0",
+  "description": "Utilities, constants and errors shared by the DocPensieve packages",
+  "type": "module",
+  "license": "MIT",
+  "engines": {
+    "node": ">=22.0.0"
+  },
+  "main": "./src/index.js",
+  "exports": {
+    ".": {
+      "types": "./types/index.d.ts",
+      "default": "./src/index.js"
+    }
+  },
+  "files": [
+    "src",
+    "types"
+  ],
+  "keywords": [
+    "docpensieve",
+    "documentation",
+    "slug",
+    "utils"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Juniors017/docpensieve.git",
+    "directory": "packages/shared"
+  },
+  "homepage": "https://github.com/Juniors017/docpensieve#readme",
+  "bugs": {
+    "url": "https://github.com/Juniors017/docpensieve/issues"
+  },
+  "author": "Valentin Chevoleau (Juniors017)",
+  "publishConfig": {
+    "access": "public"
+  },
+  "types": "./types/index.d.ts",
+  "scripts": {
+    "prepack": "tsc -b tsconfig.build.json"
+  }
+}

package/src/constants.js

@@ -0,0 +1,74 @@
+/**
+ * Constants shared by every DocPensieve package.
+ * @module @docpensieve/shared/constants
+ */
+
+/** File extensions recognised as documentation pages. */
+export const DOC_EXTENSIONS = ['.md', '.mdx'];
+
+/** Name of the configuration file at the project root. */
+export const CONFIG_FILENAME = 'docpensieve.config.js';
+
+/** Default output directory of a build. */
+export const DEFAULT_OUT_DIR = 'dist';
+
+/** Version manifest written by every build. */
+export const VERSIONS_MANIFEST = 'versions.json';
+
+/** Page slugs treated as the root of their folder (they take the folder's own URL). */
+export const INDEX_SLUGS = ['index', 'readme'];
+
+/** JSON-LD types supported by the `jsonld.type` frontmatter field. */
+export const JSONLD_TYPES = ['Article', 'TechArticle', 'BlogPosting'];
+
+/** CSS frameworks known to the ThemeEngine. */
+export const THEME_FRAMEWORKS = ['tailwind', 'custom'];
+
+/**
+ * Layouts accepted in a page's frontmatter.
+ *
+ * `doc` is the documentation layout: menu on the left, table of contents on
+ * the right, content held to reading width. `home` removes all three, which
+ * is what a landing page expects.
+ *
+ * @type {readonly string[]}
+ */
+export const PAGE_LAYOUTS = Object.freeze(['doc', 'home']);
+
+/**
+ * Class slots of the page shell.
+ *
+ * Templates hard-code no class: they ask the theme for the class of each
+ * slot. A provider only redefines what it wants to change; everything else
+ * falls back to these values. That is what lets a single template render
+ * either `dp-nav` or a string of Tailwind utilities.
+ *
+ * This table is shared: `core` reads it in its templates, `theme` extends it
+ * in its providers.
+ */
+export const DEFAULT_THEME_CLASSES = Object.freeze({
+  skip: 'dp-skip',
+  header: 'dp-header',
+  brand: 'dp-brand',
+  versions: 'dp-versions',
+  versionsList: 'dp-versions-list',
+  shell: 'dp-shell',
+  shellWide: 'dp-shell dp-shell--wide',
+  sidebar: 'dp-sidebar',
+  nav: 'dp-nav',
+  navItem: 'dp-nav-item',
+  navItemParent: 'dp-nav-item--parent',
+  navLink: 'dp-nav-link',
+  navLabel: 'dp-nav-label',
+  notice: 'dp-notice',
+  skillIcon: 'dp-skill-icon',
+  main: 'dp-main',
+  article: 'dp-article',
+  toc: 'dp-toc',
+  tocTitle: 'dp-toc-title',
+  tocList: 'dp-toc-list',
+  tocItem: 'dp-toc-item',
+  footer: 'dp-footer',
+  scrollTop: 'dp-scroll-top',
+  scrollTopIcon: 'dp-scroll-top-icon',
+});

package/src/errors.js

@@ -0,0 +1,54 @@
+/**
+ * DocPensieve error hierarchy.
+ *
+ * Every domain error extends `DocPensieveError`: that is how the CLI tells an
+ * expected error (a clear message for the user) from a bug (full stack trace).
+ *
+ * @module @docpensieve/shared/errors
+ */
+
+/** Expected domain error — the CLI prints it without a stack trace. */
+export class DocPensieveError extends Error {
+  /**
+   * @param {string} message
+   * @param {{ cause?: unknown, hint?: string }} [options] `hint` is printed
+   *   by the CLI as a suggested fix.
+   */
+  constructor(message, options = {}) {
+    super(message, { cause: options.cause });
+    this.name = this.constructor.name;
+    this.hint = options.hint;
+  }
+}
+
+/** Configuration missing, unreadable or invalid. */
+export class ConfigError extends DocPensieveError {}
+
+/** A source file could not be read or parsed. */
+export class LoaderError extends DocPensieveError {}
+
+/** MDX/Markdown compilation failed. */
+export class CompileError extends DocPensieveError {}
+
+/** Invalid `jsonld` frontmatter or inconsistent structured data. */
+export class StructuredDataError extends DocPensieveError {}
+
+/** Theme provider missing, invalid, or whose compilation failed. */
+export class ThemeError extends DocPensieveError {}
+
+/** The site could not be generated or written. */
+export class GeneratorError extends DocPensieveError {}
+
+/** Milestone not implemented yet — points to the roadmap section. */
+export class NotImplementedError extends DocPensieveError {
+  /**
+   * @param {string} what What is not implemented.
+   * @param {string} roadmapSection E.g. `'1.1 DocLoader'`.
+   */
+  constructor(what, roadmapSection) {
+    super(`${what} is not available yet.`, {
+      hint: `Planned in section ${roadmapSection} of the roadmap.`,
+    });
+    this.roadmapSection = roadmapSection;
+  }
+}

package/src/index.js

@@ -0,0 +1,12 @@
+/**
+ * @docpensieve/shared — shared utilities, constants and errors.
+ *
+ * This package depends on no other DocPensieve package: it is the leaf of the
+ * dependency graph. Anything useful to two packages or more lives here.
+ *
+ * @module @docpensieve/shared
+ */
+
+export * from './constants.js';
+export * from './errors.js';
+export * from './slug.js';

package/src/slug.js

@@ -0,0 +1,184 @@
+/**
+ * Slug and URL generation from file paths.
+ * @module @docpensieve/shared/slug
+ */
+
+import { INDEX_SLUGS } from './constants.js';
+
+/** Numeric ordering prefix: `01-`, `02_`, `10.` */
+const ORDER_PREFIX = /^\d+[-_.]/;
+
+/**
+ * Turns free text into a URL-safe slug.
+ *
+ * Accents are decomposed then dropped (`Crème` → `creme`), which keeps URLs
+ * readable instead of percent-encoded.
+ *
+ * @param {string} input
+ * @returns {string} Lowercase slug, dash-separated.
+ */
+export function slugify(input) {
+  return String(input)
+    .normalize('NFD')
+    .replace(/[\u0300-\u036f]/g, '')
+    .replace(/['’]/g, '')
+    .toLowerCase()
+    .replace(/[^a-z0-9]+/g, '-')
+    .replace(/^-+|-+$/g, '');
+}
+
+/**
+ * Converts a file path, relative to the version folder, into a page slug.
+ *
+ * Ordering prefixes are removed from every segment: they sort the sidebar,
+ * they do not build the URL.
+ *
+ * @example
+ * filePathToSlug('guide/01-install.md')  // 'guide/install'
+ * filePathToSlug('intro.mdx')            // 'intro'
+ * filePathToSlug('guide/index.md')       // 'guide'
+ * filePathToSlug('index.md')             // ''
+ *
+ * @param {string} relativePath Path relative to the version folder.
+ * @returns {string} Slug with no leading or trailing slash.
+ */
+export function filePathToSlug(relativePath) {
+  const withoutExt = String(relativePath).replace(/\.mdx?$/i, '');
+  const segments = withoutExt
+    .split(/[/\\]/)
+    .filter(Boolean)
+    .map((segment) => slugify(segment.replace(ORDER_PREFIX, '')));
+
+  const last = segments.at(-1);
+  if (last !== undefined && INDEX_SLUGS.includes(last)) {
+    segments.pop();
+  }
+
+  return segments.filter(Boolean).join('/');
+}
+
+/**
+ * Maps an asset path into URL space.
+ *
+ * Folders follow the page rule — ordering prefix removed, segment slugified —
+ * so that `02-guide/diagram.png` lands under `/guide/`, where the pages of the
+ * same folder expect it. Otherwise the sorting prefix, which never shows in a
+ * page URL, would show in the URL of its images.
+ *
+ * The file name itself stays untouched: it is the one the author writes in
+ * their Markdown, and rewriting it would break the reference.
+ *
+ * @example
+ * assetPathToSlug('02-guide/diagram.png')  // 'guide/diagram.png'
+ * assetPathToSlug('My Notes/a.png')        // 'my-notes/a.png'
+ *
+ * @param {string} relativePath Path relative to the version folder.
+ * @returns {string} Output path, slash-separated.
+ */
+export function assetPathToSlug(relativePath) {
+  const segments = String(relativePath).split(/[/\\]/).filter(Boolean);
+
+  const file = segments.pop();
+  const folders = segments.map((segment) => slugify(segment.replace(ORDER_PREFIX, '')));
+
+  return [...folders, file].filter(Boolean).join('/');
+}
+
+/**
+ * Segments of a path that leave nothing behind once slugified.
+ *
+ * `slugify` only keeps Latin letters and digits: a name made entirely of
+ * ideograms, or of punctuation, vanishes. For a page, that meant taking the
+ * home page's URL; for a folder, disappearing from the address.
+ *
+ * @example
+ * blankSegments('guide/日本語.md')   // ['日本語']
+ * blankSegments('02-guide/page.md')  // []
+ *
+ * @param {string} relativePath Path relative to the version folder.
+ * @returns {string[]} The offending segments, extension removed.
+ */
+export function blankSegments(relativePath) {
+  return String(relativePath)
+    .replace(/\.mdx?$/i, '')
+    .split(/[/\\]/)
+    .filter(Boolean)
+    .filter((segment) => slugify(segment.replace(ORDER_PREFIX, '')) === '');
+}
+
+/**
+ * Maps a **folder** path into URL space.
+ *
+ * Sibling of `assetPathToSlug`, but with no file name to spare: every segment
+ * goes through the page rule. Applying `assetPathToSlug` to a folder left its
+ * last segment untouched — `02-guide` stayed `02-guide` — and every relative
+ * target of a page in that folder missed the file actually copied.
+ *
+ * @example
+ * dirPathToSlug('02-guide/03-sub')  // 'guide/sub'
+ * dirPathToSlug('My Notes')         // 'my-notes'
+ * dirPathToSlug('')                 // ''
+ *
+ * @param {string} relativePath Path relative to the version folder.
+ * @returns {string} Output path, slash-separated.
+ */
+export function dirPathToSlug(relativePath) {
+  return String(relativePath)
+    .split(/[/\\]/)
+    .filter(Boolean)
+    .map((segment) => slugify(segment.replace(ORDER_PREFIX, '')))
+    .filter(Boolean)
+    .join('/');
+}
+
+/**
+ * Converts a page slug into an absolute site URL (trailing slash included).
+ *
+ * @example
+ * slugToUrl('guide/install')  // '/guide/install/'
+ * slugToUrl('')               // '/'
+ * slugToUrl('intro', 'v1.0')  // '/versions/v1.0/intro/'
+ *
+ * @param {string} slug Slug produced by {@link filePathToSlug}.
+ * @param {string} [versionSlug] When given, prefixes `/versions/<version>`.
+ * @returns {string} URL starting and ending with `/`.
+ */
+export function slugToUrl(slug, versionSlug) {
+  const parts = [];
+  if (versionSlug) parts.push('versions', versionSlug);
+  if (slug) parts.push(...slug.split('/').filter(Boolean));
+  return parts.length ? `/${parts.join('/')}/` : '/';
+}
+
+/**
+ * Turns a slug segment back into a readable label.
+ *
+ * A deliberate, imperfect fallback: since `slugify` dropped the accents,
+ * `creme-brulee` comes back as “Creme brulee”. Only use it when there is no
+ * real title — the sidebar and the breadcrumb prefer the frontmatter title.
+ *
+ * @example
+ * humanizeSlug('getting-started')  // 'Getting started'
+ *
+ * @param {string} segment
+ * @returns {string}
+ */
+export function humanizeSlug(segment) {
+  const words = String(segment).replace(/[-_]+/g, ' ').trim();
+  return words.charAt(0).toUpperCase() + words.slice(1);
+}
+
+/**
+ * Reads the ordering weight of a prefixed file name.
+ *
+ * @example
+ * orderOf('01-install.md')  // 1
+ * orderOf('install.md')     // Infinity
+ *
+ * @param {string} filename
+ * @returns {number} The prefix number, or `Infinity` when absent (sorted last).
+ */
+export function orderOf(filename) {
+  const match = String(filename).match(/^(\d+)[-_.]/);
+  return match ? Number(match[1]) : Infinity;
+}

package/types/constants.d.ts

@@ -0,0 +1,65 @@
+/**
+ * Constants shared by every DocPensieve package.
+ * @module @docpensieve/shared/constants
+ */
+/** File extensions recognised as documentation pages. */
+export declare const DOC_EXTENSIONS: string[];
+/** Name of the configuration file at the project root. */
+export declare const CONFIG_FILENAME = "docpensieve.config.js";
+/** Default output directory of a build. */
+export declare const DEFAULT_OUT_DIR = "dist";
+/** Version manifest written by every build. */
+export declare const VERSIONS_MANIFEST = "versions.json";
+/** Page slugs treated as the root of their folder (they take the folder's own URL). */
+export declare const INDEX_SLUGS: string[];
+/** JSON-LD types supported by the `jsonld.type` frontmatter field. */
+export declare const JSONLD_TYPES: string[];
+/** CSS frameworks known to the ThemeEngine. */
+export declare const THEME_FRAMEWORKS: string[];
+/**
+ * Layouts accepted in a page's frontmatter.
+ *
+ * `doc` is the documentation layout: menu on the left, table of contents on
+ * the right, content held to reading width. `home` removes all three, which
+ * is what a landing page expects.
+ *
+ * @type {readonly string[]}
+ */
+export declare const PAGE_LAYOUTS: readonly string[];
+/**
+ * Class slots of the page shell.
+ *
+ * Templates hard-code no class: they ask the theme for the class of each
+ * slot. A provider only redefines what it wants to change; everything else
+ * falls back to these values. That is what lets a single template render
+ * either `dp-nav` or a string of Tailwind utilities.
+ *
+ * This table is shared: `core` reads it in its templates, `theme` extends it
+ * in its providers.
+ */
+export declare const DEFAULT_THEME_CLASSES: Readonly<{
+    skip: "dp-skip";
+    header: "dp-header";
+    brand: "dp-brand";
+    versions: "dp-versions";
+    versionsList: "dp-versions-list";
+    shell: "dp-shell";
+    shellWide: "dp-shell dp-shell--wide";
+    sidebar: "dp-sidebar";
+    nav: "dp-nav";
+    navItem: "dp-nav-item";
+    navItemParent: "dp-nav-item--parent";
+    navLink: "dp-nav-link";
+    navLabel: "dp-nav-label";
+    notice: "dp-notice";
+    skillIcon: "dp-skill-icon";
+    main: "dp-main";
+    article: "dp-article";
+    toc: "dp-toc";
+    tocTitle: "dp-toc-title";
+    tocList: "dp-toc-list";
+    tocItem: "dp-toc-item";
+    footer: "dp-footer";
+    scrollTop: "dp-scroll-top";
+    scrollTopIcon: "dp-scroll-top-icon";
+}>;

package/types/errors.d.ts

@@ -0,0 +1,48 @@
+/**
+ * DocPensieve error hierarchy.
+ *
+ * Every domain error extends `DocPensieveError`: that is how the CLI tells an
+ * expected error (a clear message for the user) from a bug (full stack trace).
+ *
+ * @module @docpensieve/shared/errors
+ */
+/** Expected domain error — the CLI prints it without a stack trace. */
+export declare class DocPensieveError extends Error {
+    hint: string | undefined;
+    /**
+     * @param {string} message
+     * @param {{ cause?: unknown, hint?: string }} [options] `hint` is printed
+     *   by the CLI as a suggested fix.
+     */
+    constructor(message: string, options?: {
+        cause?: unknown;
+        hint?: string;
+    });
+}
+/** Configuration missing, unreadable or invalid. */
+export declare class ConfigError extends DocPensieveError {
+}
+/** A source file could not be read or parsed. */
+export declare class LoaderError extends DocPensieveError {
+}
+/** MDX/Markdown compilation failed. */
+export declare class CompileError extends DocPensieveError {
+}
+/** Invalid `jsonld` frontmatter or inconsistent structured data. */
+export declare class StructuredDataError extends DocPensieveError {
+}
+/** Theme provider missing, invalid, or whose compilation failed. */
+export declare class ThemeError extends DocPensieveError {
+}
+/** The site could not be generated or written. */
+export declare class GeneratorError extends DocPensieveError {
+}
+/** Milestone not implemented yet — points to the roadmap section. */
+export declare class NotImplementedError extends DocPensieveError {
+    roadmapSection: string;
+    /**
+     * @param {string} what What is not implemented.
+     * @param {string} roadmapSection E.g. `'1.1 DocLoader'`.
+     */
+    constructor(what: string, roadmapSection: string);
+}

package/types/index.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @docpensieve/shared — shared utilities, constants and errors.
+ *
+ * This package depends on no other DocPensieve package: it is the leaf of the
+ * dependency graph. Anything useful to two packages or more lives here.
+ *
+ * @module @docpensieve/shared
+ */
+export * from './constants.js';
+export * from './errors.js';
+export * from './slug.js';

package/types/slug.d.ts

@@ -0,0 +1,119 @@
+/**
+ * Slug and URL generation from file paths.
+ * @module @docpensieve/shared/slug
+ */
+/**
+ * Turns free text into a URL-safe slug.
+ *
+ * Accents are decomposed then dropped (`Crème` → `creme`), which keeps URLs
+ * readable instead of percent-encoded.
+ *
+ * @param {string} input
+ * @returns {string} Lowercase slug, dash-separated.
+ */
+export declare function slugify(input: string): string;
+/**
+ * Converts a file path, relative to the version folder, into a page slug.
+ *
+ * Ordering prefixes are removed from every segment: they sort the sidebar,
+ * they do not build the URL.
+ *
+ * @example
+ * filePathToSlug('guide/01-install.md')  // 'guide/install'
+ * filePathToSlug('intro.mdx')            // 'intro'
+ * filePathToSlug('guide/index.md')       // 'guide'
+ * filePathToSlug('index.md')             // ''
+ *
+ * @param {string} relativePath Path relative to the version folder.
+ * @returns {string} Slug with no leading or trailing slash.
+ */
+export declare function filePathToSlug(relativePath: string): string;
+/**
+ * Maps an asset path into URL space.
+ *
+ * Folders follow the page rule — ordering prefix removed, segment slugified —
+ * so that `02-guide/diagram.png` lands under `/guide/`, where the pages of the
+ * same folder expect it. Otherwise the sorting prefix, which never shows in a
+ * page URL, would show in the URL of its images.
+ *
+ * The file name itself stays untouched: it is the one the author writes in
+ * their Markdown, and rewriting it would break the reference.
+ *
+ * @example
+ * assetPathToSlug('02-guide/diagram.png')  // 'guide/diagram.png'
+ * assetPathToSlug('My Notes/a.png')        // 'my-notes/a.png'
+ *
+ * @param {string} relativePath Path relative to the version folder.
+ * @returns {string} Output path, slash-separated.
+ */
+export declare function assetPathToSlug(relativePath: string): string;
+/**
+ * Segments of a path that leave nothing behind once slugified.
+ *
+ * `slugify` only keeps Latin letters and digits: a name made entirely of
+ * ideograms, or of punctuation, vanishes. For a page, that meant taking the
+ * home page's URL; for a folder, disappearing from the address.
+ *
+ * @example
+ * blankSegments('guide/日本語.md')   // ['日本語']
+ * blankSegments('02-guide/page.md')  // []
+ *
+ * @param {string} relativePath Path relative to the version folder.
+ * @returns {string[]} The offending segments, extension removed.
+ */
+export declare function blankSegments(relativePath: string): string[];
+/**
+ * Maps a **folder** path into URL space.
+ *
+ * Sibling of `assetPathToSlug`, but with no file name to spare: every segment
+ * goes through the page rule. Applying `assetPathToSlug` to a folder left its
+ * last segment untouched — `02-guide` stayed `02-guide` — and every relative
+ * target of a page in that folder missed the file actually copied.
+ *
+ * @example
+ * dirPathToSlug('02-guide/03-sub')  // 'guide/sub'
+ * dirPathToSlug('My Notes')         // 'my-notes'
+ * dirPathToSlug('')                 // ''
+ *
+ * @param {string} relativePath Path relative to the version folder.
+ * @returns {string} Output path, slash-separated.
+ */
+export declare function dirPathToSlug(relativePath: string): string;
+/**
+ * Converts a page slug into an absolute site URL (trailing slash included).
+ *
+ * @example
+ * slugToUrl('guide/install')  // '/guide/install/'
+ * slugToUrl('')               // '/'
+ * slugToUrl('intro', 'v1.0')  // '/versions/v1.0/intro/'
+ *
+ * @param {string} slug Slug produced by {@link filePathToSlug}.
+ * @param {string} [versionSlug] When given, prefixes `/versions/<version>`.
+ * @returns {string} URL starting and ending with `/`.
+ */
+export declare function slugToUrl(slug: string, versionSlug?: string): string;
+/**
+ * Turns a slug segment back into a readable label.
+ *
+ * A deliberate, imperfect fallback: since `slugify` dropped the accents,
+ * `creme-brulee` comes back as “Creme brulee”. Only use it when there is no
+ * real title — the sidebar and the breadcrumb prefer the frontmatter title.
+ *
+ * @example
+ * humanizeSlug('getting-started')  // 'Getting started'
+ *
+ * @param {string} segment
+ * @returns {string}
+ */
+export declare function humanizeSlug(segment: string): string;
+/**
+ * Reads the ordering weight of a prefixed file name.
+ *
+ * @example
+ * orderOf('01-install.md')  // 1
+ * orderOf('install.md')     // Infinity
+ *
+ * @param {string} filename
+ * @returns {number} The prefix number, or `Infinity` when absent (sorted last).
+ */
+export declare function orderOf(filename: string): number;