Skip to content
This repository was archived by the owner on Aug 9, 2022. It is now read-only.

Commit bd5e533

Browse files
authored
Add notice for DocFx V3
1 parent efc79d0 commit bd5e533

1 file changed

Lines changed: 7 additions & 1 deletion

File tree

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,14 @@
55

66
This doclet is designed to produce a YAML representation of the Javadoc-generated documentation, that can be integrated into [DocFX](https://dotnet.github.io/docfx/).
77

8+
`Please Notice:` This default branch supports **DocFX V2** only.
9+
10+
If you are using [DocFX V3](https://github.com/dotnet/docfx/tree/v3), please check further in [main](https://github.com/docascode/docfx-doclet/tree/main) branch.
11+
812
## Getting started
913

10-
The easiest way is to just get the JAR files directly from our [releases](https://github.com/dendeli-msft/docfx-doclet/releases).
14+
The easiest way is to just get the JAR files directly from our [Release for June, 2020. Supports DocFX V2
15+
](https://github.com/docascode/docfx-doclet/releases/tag/143274).
1116

1217
Alternatively, you can clone the repository and build it with the help of Maven. You can do so by calling:
1318

@@ -23,6 +28,7 @@ mvn package
2328

2429
This will produce two JAR files that you can use - one with dependencies, and another one without.
2530

31+
2632
## Usage
2733

2834
### With `maven-javadoc-plugin`

0 commit comments

Comments
 (0)