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.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.
Already on GitHub? Sign in to your account
TypeDoc 0.26 Beta #2567
Milestone
Comments
This was referenced May 4, 2024
0.26.0-beta.1
... and now I probably disappear for 2 weeks and don't do anything, except maybe fix bugs people find ;) |
@Gerrit0 I'm excited to try packageOptions in Beta 2, but it seems the npm publish failed. |
Sorry about that! Should be up now. I suspect I might need to revert the block tag validation change, or at least rework it, as I forgot about how special inheritDoc is |
10 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
TypeDoc 0.26 is now in beta! 馃帀
Please try it out and report any issues here or in new issues:
The full release will be made on 2024-06-21.
This release includes support for TypeScript 5.5 in addition to two large features
External Markdown Pages
It has been a highly requested feature for TypeDoc to support including additional markdown pages beyond just the project's readme. In fact the original issue requesting them, #247, is the oldest issue still open. There have been a few external plugins over the years which added this, then broke with TypeDoc updates, but it's now coming to TypeDoc proper!
This feature falls into two parts:
Project level documents can be added with the
--projectDocuments
option. These documents will be added as children of the root reflection object, so are a good fit for guides on how to use the library and other top level pages that should be included in your docs.Reflection level documents can be added as children to declarations with the
@document
tag. These are intended for referencing lower level documents which are relevant when viewing documentation for that item. Note: "top level" declarations is a somewhat tricky term. The initial implementation of this feature only supportsThe markdown pages added may include YAML formatted frontmatter. TypeDoc will check the frontmatter for
title
,group
, andcategory
properties. Thetitle
property will set the name of the document used, whilegroup
andcategory
are treated like the@group
and@category
tags on a normal reflection.Note: This frontmatter must begin and end with
---
on lines by itself. TypeDoc's frontmatter extraction uses this to determine when the block ends.Example:
Localization Support
TypeDoc has always been an English project, without any real support for other languages. This version sets up the infrastructure to support changing rendered text and TypeDoc's log messages to other languages. See internationalization.md for details. Translation PRs are welcome!
Important Breaking Changes
const
interpreted as function typed via aninterface
declaration, yield unexpected comment summaries聽#2521.--media
,--includes
, and--stripYamlFrontmatter
options have been removed.Remaining Work
See the full changelog for additional details.
@document
on classes, interfaces, enums, functions, variableshtml: false
in markdown-it configurationThe text was updated successfully, but these errors were encountered: