Skip to content

Commit 51245fd

Browse files
committed
chore(docs): updated docs
1 parent 3d64ca1 commit 51245fd

File tree

4 files changed

+35
-30
lines changed

4 files changed

+35
-30
lines changed

docs/pages/docs/CHANGELOG.md

+32
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,37 @@
11
# Changelog
22

3+
## 4.4.1 (2025-01-01)
4+
5+
### Patch Changes
6+
7+
- Correctly display inline objects for tuple optional types ([#745](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/745)).
8+
- Expose isDeprecated flag to navigation category items.
9+
10+
## 4.4.0 (2024-12-30)
11+
12+
This release introduces structural enhancements to the user interface and bug fixes to enhance overall functionality.
13+
14+
### Structural Changes
15+
16+
- 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).
17+
- Extraneous "Index" headings on module landing pages have been removed, bringing the structure in line with the default HTML theme and reducing unnecessary clutter.
18+
- 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.
19+
20+
### Minor Changes
21+
22+
- Expose "isDeprecated" flag to navigation model ([#747](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/747)).
23+
- Moved source link inline and exposed to all parent symbols ([#746](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/746)).
24+
- Remove extraneous "Index" headings.
25+
- Always assign HTML anchor ids to linkable symbols within table rows.
26+
27+
### Patch Changes
28+
29+
- Always display inline object for tuple types ([#745](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/745)).
30+
- Strikeout deprecated items in reflection indexes.
31+
- Fix inline formatting of types when when "useCodeBlocks" is used ([#742](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/742)).
32+
- Expose group descriptions to module indexes.
33+
- Expose global documents with "packages" entryPointStrategy.
34+
335
## 4.3.3 (2024-12-18)
436

537
### Patch Changes

docs/pages/plugins/remark/options.mdx

+2-10
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import { Callout } from "nextra/components";
1+
import { Callout } from 'nextra/components';
22

33
# Options
44

@@ -16,15 +16,7 @@ Options can be provided as either an array of strings or an array of strings wit
1616

1717
```json filename="typedoc.json"
1818
{
19-
"remarkPlugins": [
20-
"remark-github",
21-
[
22-
"remark-toc",
23-
{
24-
"maxDepth": 3
25-
}
26-
]
27-
]
19+
"remarkPlugins": ["remark-github"]
2820
}
2921
```
3022

docs/pages/plugins/remark/useful-plugins.mdx

-19
Original file line numberDiff line numberDiff line change
@@ -2,25 +2,6 @@
22

33
Here are some [remark plugins](https://github.com/remarkjs/remark/blob/main/doc/plugins.md) that might be useful.
44

5-
## remark-toc
6-
7-
https://github.com/remarkjs/remark-toc
8-
9-
- Adds inline table of contents to pages.
10-
11-
Note: This plugin searches for a heading in the page to generate the table of contents.
12-
`typedoc-plugin-remark` inserts this heading automatically (currently to Module, Interface, Class and Enum pages).
13-
14-
```sh npm2yarn
15-
npm install remark-toc --save-dev
16-
```
17-
18-
```json filename="typedoc.json"
19-
{
20-
"remarkPlugins": ["remark-toc"]
21-
}
22-
```
23-
245
## remark-github
256

267
https://github.com/remarkjs/remark-github

packages/typedoc-plugin-markdown/CHANGELOG.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -250,7 +250,7 @@ There are two TypeDoc breaking changes that might effect users of this plugin:
250250
- The option `allReflectionsHaveOwnDocument` has been removed (this behaviour is now the default). Please see option `outputFileStrategy`](/docs/options#outputfilestrategy).
251251
- The option `entryDocument` has been renamed to `entryFileName` to better reflect its purpose.
252252
- The option `namedAnchors` has been renamed to `useHTMLAnchors` to better reflect its purpose.
253-
- The option `hideInPageTOC` has been removed. In-page TOC are no longer included by default. You can include in-page TOCs by using `typedoc-plugin-remark` and the `remark-toc` plugin.
253+
- The option `hideInPageTOC` has been removed. In-page TOC are no longer included by default.
254254
- The option `objectLiteralTypeDeclarationStyle` has been removed. Please use option `--typeDeclarationFormat=list`.
255255

256256
### Bug Fixes

0 commit comments

Comments
 (0)