typedoc-theme-yaf/src/backend/index.js

A fresh, opinionated and standalone front-end documentation application consuming Typedoc generated data.

"use strict";
/**
 * `typedoc-theme-yaf` Is a data driven single page application (SPA).\
 * You are hopefully looking at it right now.
 *
 * This backend module takes as it's input the standard TypeDoc outputs; `ProjectReflection` and `JSONOutput.ProjectReflection`,
 * and serialises it into `.json` output files for consumption by the frontend module.
 *
 * These files consist of:
 * - `.json` data fragments, one for each documentation page. This is analogous to the TypeDoc default theme `.html` output files.
 * - `yafKindSymbols.json`: a flat map of various reflection kinds to data for symbol creation.
 * - `yafNavigationMenu.json`: a deep map of reflection relationships.
 * - `yafNeedsParenthesis.json`: a flat map analogous to the TypeDoc `needsParenthesis()` method.
 * - `yafReflectionKind`: a flat map of reflection kinds analogous to the TypeDoc `ReflectionKind` map, which cannot be exported into ESM context.
 * - `yafReflectionMap`: a flat map indexed by id of all reflections providing linkage metadata.
 *
 * @module backend
 */
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
    if (k2 === undefined) k2 = k;
    var desc = Object.getOwnPropertyDescriptor(m, k);
    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
      desc = { enumerable: true, get: function() { return m[k]; } };
    }
    Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
    if (k2 === undefined) k2 = k;
    o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
    Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
    o["default"] = v;
});
var __importStar = (this && this.__importStar) || function (mod) {
    if (mod && mod.__esModule) return mod;
    var result = {};
    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
    __setModuleDefault(result, mod);
    return result;
};
var __exportStar = (this && this.__exportStar) || function(m, exports) {
    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.highlighter = void 0;
/**
 * `typedoc-theme-yaf` Strives to be visually consistent and comparable to the GitHub MarkDown rendering in look and feel.
 *
 * In order to facilitate compatibility with [github-markdown-css](https://github.com/sindresorhus/github-markdown-css),
 * the default TypeDoc highlighting module, `Shiki`, is replaced with [starry-night](https://github.com/wooorm/starry-night).
 */
exports.highlighter = __importStar(require("./highlighter"));
__exportStar(require("./YafSerialiser"), exports);
__exportStar(require("./YafTheme"), exports);
__exportStar(require("../index"), exports);
//# sourceMappingURL=index.js.map