Skip to content

Update dependency typedoc-plugin-markdown to v4 #222

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update dependency typedoc-plugin-markdown to v4 #222

wants to merge 1 commit into from

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented May 3, 2024 •
edited
Loading

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
typedoc-plugin-markdown (source) 3.17.1 -> 4.6.3 age adoption passing confidence

Release Notes

typedoc2md/typedoc-plugin-markdown (typedoc-plugin-markdown)

v4.6.3

Compare Source

Patch Changes
  • Correctly handle group title in pageTitleTemplates callback (#​807).
  • Format of optional type and getter/setter (#​804) - thanks @​normanzb.

v4.6.2

Compare Source

Patch Changes
  • Expose full declaration for returned union types (#​799).
  • Move isOptional flag inside backTicks (#​797) - thanks @​LekoArts.
  • Added support for TypeDoc's v0.28.2 features @group none, @category none and @disableGroups.

v4.6.1

Compare Source

Patch Changes
  • Correctly render html table when interfacePropertiesFormat=htmlTable (#​794).
  • Correctly handle overloaded function display in list and table views (#​793).
  • Expose comments and signatures to index signature members.
  • Wrap default values in back ticks on table views to be consistent with list views.
  • Append semi colons to signature in code blocks.

v4.6.0

Compare Source

This release continues the effort to further align to TypeDoc’s default theme, with improvements that make the plugin more consistent and predictable.

Architectural Changes
  • Introduced support for TypeDoc core routers. This allows output files to be generated in the same structure as the default HTML theme, while still using the plugin’s Markdown theme.
  • Exported routers to the public API, enabling customization by other plugins.
Structural Changes
  • Package readme's (when "entryPointStrategy" is "packages") are now merged with the package index page producing a single entrypoint for packages with an associated readme.
    This aligns with the default theme and improves navigation.
  • To support core routers, a "Hierarchy Summary" page has been introduced to all routers. This feature is turned off by default but can be enabled by setting "includeHierarchySummary" to "true".
  • When "includeHierarchySummary" is "true", symbols with an available hierarchy now include an associated "Hierarchy" Markdown heading with a "View Summary" link as per the default theme.
  • Class constructor headings now read "Constructor". This aligns to the TypeDoc internal reflection name and fixes issues with internal anchoring not resolving correctly.
Minor Changes
  • Implemented support for consuming TypeDoc core routers.
  • Exported routers to public api.
  • Implemented a hierarchy summary page as per default theme.
  • Updated "Constructor" titles of classes to fix internal anchor issues.
Patch Changes
  • Fix incompatibility when used with "outputs" (#​788).
  • Utilize "anchorPrefix" option to ensure unique anchors linking if required (#​764).

v4.5.2

Compare Source

Patch Changes
  • Ensure all file paths use forward slashes in windows (#​782).

v4.5.1

Compare Source

Patch Changes
  • Correctly handle package index paths (#​782).
  • Make all options optional in PluginOptions interface (#​781).

v4.5.0

Compare Source

This release introduces support for TypeDoc 0.28 that contains several under-the-hood breaking API changes.

From a consumer perspective there should be no direct breaking change from the plugin itself, but there are some architectural and output structure changes to consider.

Architectural Changes
  • This plugin now utilizes TypeDoc's router feature. This implementation replaces the now deprecated "outputFileStrategy" option. "outputFileStrategy" is still supported for now, but will now point to the "member" and "module" router keys respectively. Further details are contained in the documentation website.
  • Please note that separate strategies for output generation in different packages (when entryPointStrategy=packages) is no longer possible with this new architecture.
Structural Changes
  • As per TypeDoc model updates, Object literal Type Alias members are now rendered in groups ("Properties", "Methods") etc rather than under a single "Type Declaration" heading.
  • A new option "typeAliasPropertiesFormat" has been exposed to place properties rendered from the updated structure to a table format.
  • Type parameter list views have been updated to separate items with markdown headings for consistency and to improve readability when parameters have detailed explanations or complex properties. If type parameters are straightforward and few in number switching to parametersFormat=table might be preferable.
Minor Changes
  • Implemented custom routers for plugin to support TypeDoc 0.28 router implementation.
  • Added "typeAliasPropertiesFormat" option to support TypeDoc 0.28 updated behaviour for Object literal type alias types.
Patch Changes
  • Mark object properties as optional in PluginOptions interface (#​777).

v4.4.2

Compare Source

Patch Changes
  • Handle duplicate symbols with leading underscores.
  • Correctly flag optional nested parameters (#​765).
  • Introduced ja theme translations as per TypeDoc 0.27.7.
  • Expose anchors to relative document links (thanks @​matus-vacula).

v4.4.1

Compare Source

Patch Changes
  • Correctly display inline objects for tuple optional types (#​745).
  • Expose isDeprecated flag to navigation category items.

v4.4.0

Compare Source

This release introduces structural enhancements to the user interface and bug fixes to enhance overall functionality.

Structural Changes
  • Source file links are now placed inline rather than under separate "Defined in" headings. This change aligns with the default HTML theme, generates more compact output, and improves the readability of automatically generated Table of Contents (TOCs).
  • Extraneous "Index" headings on module landing pages have been removed, bringing the structure in line with the default HTML theme and reducing unnecessary clutter.
  • Anchor IDs are now applied to linkable symbols within table rows by default. Previously, the useHTMLAnchors option was required, but since there is no alternative way to link to these items, this behaviour is now the default.
Minor Changes
  • Expose "isDeprecated" flag to navigation model (#​747).
  • Moved source link inline and exposed to all parent symbols (#​746).
  • Remove extraneous "Index" headings.
  • Always assign HTML anchor ids to linkable symbols within table rows.
Patch Changes
  • Always display inline object for tuple types (#​745).
  • Strikeout deprecated items in reflection indexes.
  • Fix inline formatting of types when when "useCodeBlocks" is used (#​742).
  • Expose group descriptions to module indexes.
  • Expose global documents with "packages" entryPointStrategy.

v4.3.3

Compare Source

Patch Changes
  • Correctly handle anchor resolutions with table formats.
  • Fix invalid typescript syntax for type aliases inside declaration code blocks when "useCodeBlocks" is true (#​741).

v4.3.2

Compare Source

Patch Changes
  • Enable {@​link} resolution on type alias properties (#​732).
  • Remove superfluous name attribute when "useHtmlAnchors" is true..
  • Escape characters inside @link tags.
  • Fixed spacing around inline object declarations.
  • Always expose type arguments of reference types as per default theme (#​733).

v4.3.1

Compare Source

Patch Changes
  • Expose type declarations to array types.
  • Correctly wrap array of unions in parenthesis (#​719).
  • Omit inline parameter declarations when not useful (#​720).

v4.3.0

Compare Source

This release introduces support for TypeDoc 0.27 and some additional UX features and improvements in addition to some bug fixes.

Architectural Changes

Please see the full TypeDoc changelog for additional information.

There are two TypeDoc breaking changes that might effect users of this plugin:

  • TypeDoc has converted to ESM and therefore all public and local CommonJs plugins will need to be refactored to ESM.
  • TypeScript <5.0 is no longer supported.
Structural Changes
  • Parameters list views have been updated to separate items with markdown headings to improve readability when parameters have detailed explanations examples, or sub-properties. If parameters are straightforward and few in number switching to parametersFormat=table might be preferable.
  • Improved structure of curried and overloaded signatures.
  • Page headings have been simplified to simply display project title as per default theme.
New Features
  • Exposed formatting with prettier options "formatWithPrettier" and "prettierConfigFile" that enables additional formatting of Markdown if Prettier is installed on a project.
  • Exposed "typeDeclarationVisibility" option to provide a "compact" output structure (#​703).
  • Exposed "pageTitleTemplates" option that accepts a string with placeholder or function arguments to control page titles (#​715).
Patch Changes
  • Improved structure of curried and overloaded signatures (#​714) (#​718)
  • The "hideGroupHeadings" option respects group order (#​716)
  • Handle Optional types correctly (#​719).

v4.2.10

Compare Source

Patch Changes
  • Enhanced the formatting and structure of accessor output (#​711)

v4.2.9

Compare Source

Patch Changes
  • Expose @return block tags on declarations (#​694)
  • Add parentheses on function names in type declaration table views (#​696)

v4.2.8

Compare Source

Patch Changes
  • Fix missing slash when public path is prefixed with http (#​688)

v4.2.7

Compare Source

Patch Changes
  • Correctly handle top level custom groups in navigation (#​685)
  • Fix missing index descriptions for some signatures (#​670)
  • Add '?' for optional type declarations in tables

v4.2.6

Compare Source

Patch Changes
  • Expose missing entrypoints to navigation (#​663)
  • Fix missing function descriptions in indexes

v4.2.5

Compare Source

Patch Changes
  • Expose comment for arrow functions in type declarations (#​670)
  • Tables generated with the "htmlTable" key will include <thead> and <tbody> elements to fix MDX compatibility issues (#​671)
  • Expose missing descriptions with accessor keyword (#​664)

v4.2.4

Compare Source

Patch Changes
  • Expose comments to reflections with the accessor keyword (#​664)
  • Omit constructors from category groups (#​661)
  • Update categories structure in navigation to match interface model

v4.2.3

Compare Source

Patch Changes
  • Fix missing return comments for const functions (#​656)

v4.2.2

Compare Source

Patch Changes
  • Correctly resolve comment summary for const functions (#​656)
  • Fix anchor links containing generics (#​655)

v4.2.1

Compare Source

Patch Changes
  • Enhanced the formatting and structure of accessor output (#​711)

v4.2.0

Compare Source

Minor Changes
  • Exposed "modulesFileName" option (#​647)
  • Write .nojekyll file if TypeDocs "githubPages" option is true (#​650)
  • Exposed "blockTagsPreserveOrder" option to configure ordering of comment block tags (#​627).
  • Exposed "useHTMLEncodedBrackets" option for alternative angle bracket escaping(#​564).

v4.1.2

Compare Source

Patch Changes
  • Support TypeDoc 0.26 relative links implementation (#​645).

v4.1.1

Compare Source

Patch Changes
  • Normalize window paths when "publicPath" is set (#​639)

v4.1.0

Compare Source

New Features
  • Theme support for TypeDoc’s 0.26 localization model.
  • Theme support for TypeDoc’s 0.26 documents implementation.
  • Exposed a new key "htmlTable" to formatting options enabling block elements to render as intended inside table cells. Affects all existing formatting options. Fixes (#​618).
  • Added new formatting options --classPropertiesFormat, --interfacePropertiesFormat and --propertyMembersFormat to further control formatting of different declaration structures.
  • Supports the ability to control what table columns are rendered with the --tableColumnSettings option.
Patch Changes
  • Handle duplicate files when tagged in same group (#​625)
  • Fix issues with tables and block tags (#​618)

v4.0.3

Compare Source

Patch Changes
  • Remove superfluous quotes from prop names (#​619)
  • Fix display of index descriptions in tables (#​618)

v4.0.2

Compare Source

Patch Changes
  • Fix symbol url anchors when "flattenOutputFiles" is "true" (#​616)
  • Normalize line breaks and tags within table columns (#​615)
  • Remove superfluous spaces and symbol on external links (#​614)
  • Escape all angle brackets with "santizeComments" (#​612)
  • Correctly handle quoted symbol names (#​611)
  • Correctly handle excludeScopesInPaths in windows (#​610)

v4.0.1

Compare Source

Patch Changes
  • Remove superfluous newlines from table column descriptions (#​591).
  • Handle multiple @example tags on same reflection.
  • Fix missing extended by definitions.
  • Escape Symbols with signatures correctly.

v4.0.0

Compare Source

v4 is a major release that includes a number of bug fixes, new features and UI improvements.

Architectural Changes
  • Handlebars as a dependency has been removed.
  • Updated customization model with the ability to set hooks, events and custom theming.
  • Exposed navigation structure.
New Features
  • Updated output file structure.
  • Improved and cleaner UI.
  • A set of updated and additional new options with comprehensive documentation.
  • Exported option types and JSON schema.
Structural Changes
  • Each module member is now output to its own file by default. See option --outputFileStrategy. To achieve the same output as v3 (whereby only Classes, Enums and Interfaces have their own file), set the option membersWithOwnFile option.
  • Parameters are output as a list by default. To achieve the same output as v3 (where parameters are output as a table), use option --parametersFormat=table.
Breaking Changes
  • Because the file structure has changed you may need to update any cross references to files in your documentation.
  • Setting theme to "markdown" is no longer required and should be removed.
  • The option indexTitle has been removed. Please use the "title.indexPage" key with option --textContentMappings.
  • The option allReflectionsHaveOwnDocument has been removed (this behaviour is now the default). Please see option outputFileStrategy](/docs/options#outputfilestrategy).
  • The option entryDocument has been renamed to entryFileName to better reflect its purpose.
  • The option namedAnchors has been renamed to useHTMLAnchors to better reflect its purpose.
  • The option hideInPageTOC has been removed. In-page TOC are no longer included by default.
  • The option objectLiteralTypeDeclarationStyle has been removed. Please use option --typeDeclarationFormat=list.
Bug Fixes
  • Duplication in callback/callable/function properties. (#​581).
  • @​experimental / @​internal annotations. (#​556)
  • Fix events output and strike-through deprecated items. (#​534)
  • Class static functions are no longer marked. (#​533)
  • @​example block not rendered with Headline (#​501)
  • Support for categories (#​499)
  • Correctly resolve package readme urls from member pages. (#​483)
  • Add the ability to add a separate frontmatter for readme file. (#​469)
  • Items in tables are not linkable. (#​463)
  • Custom i18n texts. (#​458)
  • How to improve the formatting for types?. (#​456)
  • How to change title format. (#​450)
  • Export Docusaurus plugin options type. (#​440)
  • How to export interface as a table. (#​403)
  • Broken Link caused by Typescript class being defined in an index file. (#​402)
  • Markdown plugin inserts unnecessary escape characters. (#​398)
  • Potential bug with optional function argument. (#​396)
  • Respect monorepo readmeFile configuration (#​383)
  • Embed all objects under a Module/Namespace onto single page. (#​338)
  • Extra spaces when merging lines in a table. (#​331)
  • Does not support namespace (or module) and interface with same name. (#​300)
  • Integration with VitePress? (#​287)
  • Typedoc comments with text wrapped in < and > breaks Docusaurus Markdown parser. (#​276)
  • Navigation support? (#​262)
  • Sidebar Category Support? (#​213)
  • Properties as Table like function properties. (#​109)
  • Provide a link/excerpt/screenshot to a demo/example rendered output (#​102)

Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻ Rebasing: Whenever PR is behind base branch, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.

  • If you want to rebase/retry this PR, check this box

This PR was generated by Mend Renovate. View the repository job log.

@renovate renovate bot requested a review from Pandapip1 as a code owner May 3, 2024 15:10
@socket-security Socket Security
Copy link

socket-security bot commented May 3, 2024 •
edited
Loading

Review the following changes in direct dependencies. Learn more about Socket for GitHub.

Diff Package Supply Chain
Security		 Vulnerability Quality Maintenance License
Updatedtypedoc-plugin-markdown@​3.17.1 ⏵ 4.6.3100 +110078 -695100

View full report

@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch from b480073 to eb5d6cb Compare May 7, 2024 02:25
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch from eb5d6cb to 141f3de Compare May 16, 2024 01:03
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch from 141f3de to 5504f2c Compare May 27, 2024 13:08
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch from 5504f2c to 93074f5 Compare June 22, 2024 13:45
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch from 93074f5 to 1fbfd87 Compare June 30, 2024 21:56
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch 3 times, most recently from 787af61 to 0fe4d70 Compare July 11, 2024 22:05
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch 2 times, most recently from b3bee8c to c8f2df1 Compare July 24, 2024 20:34
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch 2 times, most recently from f66e6a5 to b0f4bb2 Compare August 15, 2024 22:50
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch from b0f4bb2 to 5e0897a Compare August 25, 2024 10:52
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch from 5e0897a to d357ca1 Compare September 5, 2024 22:21
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch from d357ca1 to cf159f0 Compare September 22, 2024 22:58
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch 2 times, most recently from 7973c01 to 8f0dc84 Compare October 2, 2024 09:48
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch from 8f0dc84 to 9b5d927 Compare November 2, 2024 00:28
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch 2 times, most recently from c516cb1 to 708953a Compare December 2, 2024 00:52
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch from 708953a to f29b8d2 Compare December 8, 2024 19:29
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch from f29b8d2 to add3503 Compare December 19, 2024 00:26
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch 2 times, most recently from b4c8f1c to d8223dd Compare January 1, 2025 18:44
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch from d8223dd to 134d856 Compare February 10, 2025 01:29
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch 3 times, most recently from 4cd80dc to 94303cd Compare March 19, 2025 11:46
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch from 94303cd to de4e980 Compare March 23, 2025 22:40
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch from de4e980 to 0335250 Compare April 2, 2025 10:48
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch from 0335250 to 0bd7a56 Compare April 9, 2025 19:12
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch from 0bd7a56 to ed0714e Compare April 23, 2025 17:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Pandapip1 Pandapip1 Awaiting requested review from Pandapip1 Pandapip1 is a code owner

At least 0 approving reviews are required to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
0 participants