typedoc.config.js

/**
 * @type { import('typedoc').TypeDocOptions & import('typedoc-plugin-markdown').PluginOptions }
 **/
module.exports = {
  hostedBaseUrl: "https://www.electron.build",
  name: "Electron-Builder",
  entryPoints: ["packages/*"],
  entryPointStrategy: "packages",
  cleanOutputDir: false,
  flattenOutputFiles: true,
  plugin: [
    "typedoc-plugin-markdown",
    // "./scripts/renderer/out/customRendererPlugin.js"
  ],
  excludeExternals: true,
  excludePrivate: true,
  excludeProtected: true,
  excludeNotDocumented: false,
  includeVersion: true,
  hideGroupHeadings: true,
  hidePageTitle: true,
  disableSources: true,
  hidePageHeader: true,
  useHTMLEncodedBrackets: true,
  preserveAnchorCasing: true,
  // groupOrder: ["source-order"],
  // "readme": "none",
  // "sort": ["kind"],
  // "kindSortOrder": ["Function", "Interface", "TypeAlias"],
  // indexFormat: "table",
  // parametersFormat: "table",
  // interfacePropertiesFormat: "table",
  // classPropertiesFormat: "table",
  // enumMembersFormat: "table",
  // typeDeclarationFormat: "table",
  // propertyMembersFormat: "table",
  tableColumnSettings: {
    hideDefaults: false,
    hideInherited: false,
    hideModifiers: true,
    hideOverrides: true,
    hideSources: true,
    hideValues: false,
    leftAlignHeaders: false,
  },
  out: "./docs",
  visibilityFilters: {
    protected: false,
    private: false,
    inherited: false,
    external: false,
  },
}