@documentalist/[email protected]

Type	Description	Link
Break	Upgrade to typedoc to v0.25.x, which supports TypeScript v4.6 - v5.2	#156
Break	Upgrade minimum Node.js engine to v18.x	#236
Break	Rename all interfaces to drop the I prefix: - IPluginEntry -> PluginEntry - IMarkdownPluginOptions -> MarkdownPluginOptions - INpmPluginOptions -> NpmPluginOptions - ITypescriptPluginOptions -> TypescriptPluginOptions	#156

@documentalist/[email protected]

Type	Description	Link
Feature	Export new type alias TsDocEntry	#156
Break	Upgrade minimum Node.js engine to v18.x	#236
Break	Rename all interfaces to drop the I prefix: - ICompiler -> Compiler - IMetadata -> Metadata - IBlock -> Block - IKssModifier -> KssModifier - IKSSExample -> KSSExample - IKSSPluginData -> KSSPluginData - IMarkdownPluginData -> MarkdownPluginData - IPageNode -> PageNode - IPageData -> PageData - INavigable -> Navigable - IHeadingNode -> HeadingNode - INpmPackage -> NpmPackageInfo - INpmPluginData -> NpmPluginData - IPlugin -> Plugin - IFile -> File - ITag -> Tag - IHeadingTag -> HeadingTag - ITsFlags -> TsFlags - ITsDocBase -> TsDocBase - ITsConstructor -> TsConstructor - ITsMethod -> TsMethod - ITsCallable -> TsCallable - ITsSignature -> TsSignature - ITsDefaultValue -> TsDefaultValue - ITsObjectDefinition -> TsObjectDefinition - ITsProperty -> TsProperty - ITsParameter -> TsParameter - ITsClass -> TsClass - ITsAccessor -> TsAccessor - ITsEnumMember -> TsEnumMember - ITsEnum -> TsEnum - ITypescriptPluginData -> TypescriptPluginData	#156

v1.6.0

• #79 Typescript includeNodeModules option
• #81 Upgrade typedoc and TypeScript for TypeScript 3.2 support
• #82 Declare Node 6.5 as the minimum supported engine

v1.5.0

• #76 Upgrade typedoc to 0.12.0 for TypeScript 3.0 support

v1.4.1

• #71 Markdown plugin: improve error message around unknown options.navPage

v1.4.0

• 🌟 #70 new NpmPlugin provides NPM package data for package.json files

  import { Documentalist, NpmPlugin } from "documentalist";
  new Documentalist({ sourceBaseDir: "../../" })
     .use("package.json", new NpmPlugin({ excludePrivate: true, excludeNames: [/-app$/] }))
     .documentGlobs("packages/*/package.json")
     .then(({ npm }) => console.log(npm["package-name"].latestVersion));

  • version info is fetched for published packages using npm info
  • unpublished packages expose only latestVersion from package.json and are marked published: false
• #69 MarkdownPlugin page nodes now have sourcePath property
• new Documentalist() option: sourceBaseDir is starting point for relative sourcePath fields

v1.3.2

• fix NPM publishing

v1.3.1

• #68 linkify callback function now receives a third index argument

v1.3.0

• support for const/type object literal pairs, exposed as enum and enum members. #66
• migrate to CircleCI 2.0 #67

v1.2.0

• target ES5 for typescript compilation for IE11 support #64