Skip to content

Commit 7b25e84

Browse files
committed
More docs about custom tags
1 parent fe89773 commit 7b25e84

1 file changed

Lines changed: 10 additions & 1 deletion

File tree

site/tags.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,14 +67,23 @@ compiler can infer the same information directly from code. Any tags which are n
6767
result in a warning being emitted. TypeDoc will still parse the documentation comment, using context
6868
clues to determine the likely intended tag type.
6969

70-
## Defining Tags
70+
## Custom Tags
71+
72+
TypeDoc's default list of tags primarily consists of tags which are defined by the [TSDoc](https://tsdoc.org/)
73+
standard or have custom behavior associated with them. It also includes some [JSDoc](https://jsdoc.app/) tags
74+
which are very widely used but have no associated behavior to reduce the need for custom configuration.
75+
76+
If you previously used another documentation generator or want to introduce a tag for a standard heading
77+
in your documentation, TypeDoc supports defining custom tags which should not produce a warning. When a block
78+
tag with no special behavior is encountered, TypeDoc will simply render it in the documentation.
7179

7280
TypeDoc supports defining what tags are supported through either a `tsdoc.json` file or via the
7381
`--blockTags`, `--inlineTags`, and `--modifierTags` options. If defined in a `tsdoc.json` file,
7482
the file **must** be placed alongside `tsconfig.json`. See the
7583
[TSDoc documentation](https://tsdoc.org/pages/packages/tsdoc-config/) for details on the file format.
7684

7785
```json
86+
// tsdoc.json
7887
{
7988
"$schema": "https://developer.microsoft.com/en-us/json-schemas/tsdoc/v0/tsdoc.schema.json",
8089
"extends": ["typedoc/tsdoc.json"],

0 commit comments

Comments
 (0)