Skip to content
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

feat: experimental support for markdown output #9232

Merged
merged 14 commits into from
Sep 22, 2023
+3,039 −27
Merged

feat: experimental support for markdown output #9232

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
959506d
feat: initial support of markdown output
yufeih Sep 21, 2023
e491edf
Fix tests
yufeih Sep 21, 2023
6b0f6f1
publish seed markdown to gh pages for preview
yufeih Sep 21, 2023
b2bf6b0
test(snapshot): update snapshots for 3b46445534ea21756d022145d661c592…
yufeih Sep 21, 2023
51dbd80
separate ns and assembly as two lines
yufeih Sep 21, 2023
ff6b3c3
Merge branch 'md' of https://github.com/dotnet/docfx into md
yufeih Sep 21, 2023
a4bd9eb
test(snapshot): update snapshots for 2f52e6b0101fb123e873d2672989ebf3…
yufeih Sep 21, 2023
a7cbf86
use soft break for info
yufeih Sep 21, 2023
92c3afc
Merge branch 'md' of https://github.com/dotnet/docfx into md
yufeih Sep 21, 2023
78c1554
test(snapshot): update snapshots for 7ebfed10487aef28cf049e4736659ec0…
yufeih Sep 21, 2023
82c9d25
basic TOC generation
yufeih Sep 21, 2023
3f96305
Merge branch 'md' of https://github.com/dotnet/docfx into md
yufeih Sep 21, 2023
ffe7a17
Merge branch 'main' into md
yufeih Sep 21, 2023
9ffdc84
test(snapshot): update snapshots for 5a649558a6d877a69d2ad0ee23907e52…
yufeih Sep 21, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions ...fx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromAssembly.Class1.verified.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
# Class Class1

_Namespace:_ [BuildFromAssembly](BuildFromAssembly.md)

_Assembly:_ BuildFromAssembly.dll
__Namespace:__ [BuildFromAssembly](BuildFromAssembly.md)
__Assembly:__ BuildFromAssembly.dll

This is a test class.

Expand Down
5 changes: 2 additions & 3 deletions ...hot.Tests/SamplesTest.SeedMarkdown/BuildFromCSharpSourceCode.CSharp.verified.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
# Class CSharp

_Namespace:_ [BuildFromCSharpSourceCode](BuildFromCSharpSourceCode.md)

_Assembly:_ ?.dll
__Namespace:__ [BuildFromCSharpSourceCode](BuildFromCSharpSourceCode.md)
__Assembly:__ ?.dll

```csharp
public class CSharp
Expand Down
5 changes: 2 additions & 3 deletions ...t.Tests/SamplesTest.SeedMarkdown/BuildFromProject.Class1.IIssue8948.verified.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
# Interface IIssue8948

_Namespace:_ [BuildFromProject](BuildFromProject.md)

_Assembly:_ BuildFromProject.dll
__Namespace:__ [BuildFromProject](BuildFromProject.md)
__Assembly:__ BuildFromProject.dll

```csharp
public interface Class1.IIssue8948
Expand Down
5 changes: 2 additions & 3 deletions ...ot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.Class1.Issue8665.verified.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
# Class Issue8665

_Namespace:_ [BuildFromProject](BuildFromProject.md)

_Assembly:_ BuildFromProject.dll
__Namespace:__ [BuildFromProject](BuildFromProject.md)
__Assembly:__ BuildFromProject.dll

```csharp
public class Class1.Issue8665
Expand Down
5 changes: 2 additions & 3 deletions ...SamplesTest.SeedMarkdown/BuildFromProject.Class1.Issue8696Attribute.verified.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
# Class Issue8696Attribute

_Namespace:_ [BuildFromProject](BuildFromProject.md)

_Assembly:_ BuildFromProject.dll
__Namespace:__ [BuildFromProject](BuildFromProject.md)
__Assembly:__ BuildFromProject.dll

```csharp
public class Class1.Issue8696Attribute : Attribute
Expand Down
5 changes: 2 additions & 3 deletions ...ot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.Class1.Issue8948.verified.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
# Class Issue8948

_Namespace:_ [BuildFromProject](BuildFromProject.md)

_Assembly:_ BuildFromProject.dll
__Namespace:__ [BuildFromProject](BuildFromProject.md)
__Assembly:__ BuildFromProject.dll

```csharp
public class Class1.Issue8948 : Class1.IIssue8948
Expand Down
5 changes: 2 additions & 3 deletions ...pshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.Class1.Test`1.verified.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
# Class Test

_Namespace:_ [BuildFromProject](BuildFromProject.md)

_Assembly:_ BuildFromProject.dll
__Namespace:__ [BuildFromProject](BuildFromProject.md)
__Assembly:__ BuildFromProject.dll

```csharp
public class Class1.Test<T>
Expand Down
5 changes: 2 additions & 3 deletions ...cfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.Class1.verified.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
# Class Class1

_Namespace:_ [BuildFromProject](BuildFromProject.md)

_Assembly:_ BuildFromProject.dll
__Namespace:__ [BuildFromProject](BuildFromProject.md)
__Assembly:__ BuildFromProject.dll

```csharp
public class Class1 : IClass1
Expand Down
5 changes: 2 additions & 3 deletions ...napshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.IInheritdoc.verified.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
# Interface IInheritdoc

_Namespace:_ [BuildFromProject](BuildFromProject.md)

_Assembly:_ BuildFromProject.dll
__Namespace:__ [BuildFromProject](BuildFromProject.md)
__Assembly:__ BuildFromProject.dll

```csharp
public interface IInheritdoc
Expand Down
5 changes: 2 additions & 3 deletions ...lesTest.SeedMarkdown/BuildFromProject.Inheritdoc.Issue6366.Class1`1.verified.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
# Class Class1

_Namespace:_ [BuildFromProject](BuildFromProject.md)

_Assembly:_ BuildFromProject.dll
__Namespace:__ [BuildFromProject](BuildFromProject.md)
__Assembly:__ BuildFromProject.dll

```csharp
public abstract class Inheritdoc.Issue6366.Class1<T>
Expand Down
5 changes: 2 additions & 3 deletions ...mplesTest.SeedMarkdown/BuildFromProject.Inheritdoc.Issue6366.Class2.verified.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
# Class Class2

_Namespace:_ [BuildFromProject](BuildFromProject.md)

_Assembly:_ BuildFromProject.dll
__Namespace:__ [BuildFromProject](BuildFromProject.md)
__Assembly:__ BuildFromProject.dll

```csharp
public class Inheritdoc.Issue6366.Class2 : Inheritdoc.Issue6366.Class1<bool>
Expand Down
5 changes: 2 additions & 3 deletions ...ests/SamplesTest.SeedMarkdown/BuildFromProject.Inheritdoc.Issue6366.verified.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
# Class Issue6366

_Namespace:_ [BuildFromProject](BuildFromProject.md)

_Assembly:_ BuildFromProject.dll
__Namespace:__ [BuildFromProject](BuildFromProject.md)
__Assembly:__ BuildFromProject.dll

```csharp
public class Inheritdoc.Issue6366
Expand Down
5 changes: 2 additions & 3 deletions ...ests/SamplesTest.SeedMarkdown/BuildFromProject.Inheritdoc.Issue7035.verified.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
# Class Issue7035

_Namespace:_ [BuildFromProject](BuildFromProject.md)

_Assembly:_ BuildFromProject.dll
__Namespace:__ [BuildFromProject](BuildFromProject.md)
__Assembly:__ BuildFromProject.dll

```csharp
public class Inheritdoc.Issue7035
Expand Down
5 changes: 2 additions & 3 deletions ...ests/SamplesTest.SeedMarkdown/BuildFromProject.Inheritdoc.Issue7484.verified.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
# Class Issue7484

_Namespace:_ [BuildFromProject](BuildFromProject.md)

_Assembly:_ BuildFromProject.dll
__Namespace:__ [BuildFromProject](BuildFromProject.md)
__Assembly:__ BuildFromProject.dll

This is a test class to have something for DocFX to document.

Expand Down
5 changes: 2 additions & 3 deletions ...ests/SamplesTest.SeedMarkdown/BuildFromProject.Inheritdoc.Issue8101.verified.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
# Class Issue8101

_Namespace:_ [BuildFromProject](BuildFromProject.md)

_Assembly:_ BuildFromProject.dll
__Namespace:__ [BuildFromProject](BuildFromProject.md)
__Assembly:__ BuildFromProject.dll

```csharp
public class Inheritdoc.Issue8101
Expand Down
5 changes: 2 additions & 3 deletions ...ests/SamplesTest.SeedMarkdown/BuildFromProject.Inheritdoc.Issue8129.verified.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
# Struct Issue8129

_Namespace:_ [BuildFromProject](BuildFromProject.md)

_Assembly:_ BuildFromProject.dll
__Namespace:__ [BuildFromProject](BuildFromProject.md)
__Assembly:__ BuildFromProject.dll

```csharp
public struct Inheritdoc.Issue8129
Expand Down
5 changes: 2 additions & 3 deletions ...Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.Inheritdoc.verified.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
# Class Inheritdoc

_Namespace:_ [BuildFromProject](BuildFromProject.md)

_Assembly:_ BuildFromProject.dll
__Namespace:__ [BuildFromProject](BuildFromProject.md)
__Assembly:__ BuildFromProject.dll

```csharp
public class Inheritdoc : IInheritdoc, IDisposable
Expand Down
5 changes: 2 additions & 3 deletions ...pshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.Issue8540.A.A.verified.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
# Class A

_Namespace:_ [BuildFromProject](BuildFromProject.md).[Issue8540](BuildFromProject.Issue8540.md).[A](BuildFromProject.Issue8540.A.md)

_Assembly:_ BuildFromProject.dll
__Namespace:__ [BuildFromProject](BuildFromProject.md).[Issue8540](BuildFromProject.Issue8540.md).[A](BuildFromProject.Issue8540.A.md)
__Assembly:__ BuildFromProject.dll

```csharp
public class A
Expand Down
5 changes: 2 additions & 3 deletions ...pshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.Issue8540.B.B.verified.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
# Class B

_Namespace:_ [BuildFromProject](BuildFromProject.md).[Issue8540](BuildFromProject.Issue8540.md).[B](BuildFromProject.Issue8540.B.md)

_Assembly:_ BuildFromProject.dll
__Namespace:__ [BuildFromProject](BuildFromProject.md).[Issue8540](BuildFromProject.Issue8540.md).[B](BuildFromProject.Issue8540.B.md)
__Assembly:__ BuildFromProject.dll

```csharp
public class B
Expand Down
5 changes: 2 additions & 3 deletions ...hot.Tests/SamplesTest.SeedMarkdown/BuildFromVBSourceCode.BaseClass1.verified.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
# Class BaseClass1

_Namespace:_ [BuildFromVBSourceCode](BuildFromVBSourceCode.md)

_Assembly:_ ?.dll
__Namespace:__ [BuildFromVBSourceCode](BuildFromVBSourceCode.md)
__Assembly:__ ?.dll

This is the BaseClass

Expand Down
5 changes: 2 additions & 3 deletions ...napshot.Tests/SamplesTest.SeedMarkdown/BuildFromVBSourceCode.Class1.verified.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
# Class Class1

_Namespace:_ [BuildFromVBSourceCode](BuildFromVBSourceCode.md)

_Assembly:_ ?.dll
__Namespace:__ [BuildFromVBSourceCode](BuildFromVBSourceCode.md)
__Assembly:__ ?.dll

This is summary from vb class...

Expand Down
5 changes: 2 additions & 3 deletions ...x.Snapshot.Tests/SamplesTest.SeedMarkdown/CatLibrary.CatException`1.verified.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
# Class CatException

_Namespace:_ [CatLibrary](CatLibrary.md)

_Assembly:_ CatLibrary.dll
__Namespace:__ [CatLibrary](CatLibrary.md)
__Assembly:__ CatLibrary.dll

```csharp
public class CatException<T> : Exception, ISerializable
Expand Down
5 changes: 2 additions & 3 deletions test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/CatLibrary.Cat`2.verified.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
# Class Cat

_Namespace:_ [CatLibrary](CatLibrary.md)

_Assembly:_ CatLibrary.dll
__Namespace:__ [CatLibrary](CatLibrary.md)
__Assembly:__ CatLibrary.dll

<p>Here's main class of this <i>Demo</i>.</p>
<p>You can see mostly type of article within this class and you for more detail, please see the remarks.</p>
Expand Down
5 changes: 2 additions & 3 deletions .../docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/CatLibrary.Complex`2.verified.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
# Class Complex

_Namespace:_ [CatLibrary](CatLibrary.md)

_Assembly:_ CatLibrary.dll
__Namespace:__ [CatLibrary](CatLibrary.md)
__Assembly:__ CatLibrary.dll

```csharp
public class Complex<T, J>
Expand Down
5 changes: 2 additions & 3 deletions ...amplesTest.SeedMarkdown/CatLibrary.Core.ContainersRefType.ColorType.verified.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
# Enum ColorType

_Namespace:_ [CatLibrary](CatLibrary.md).[Core](CatLibrary.Core.md)

_Assembly:_ CatLibrary.Core.dll
__Namespace:__ [CatLibrary](CatLibrary.md).[Core](CatLibrary.Core.md)
__Assembly:__ CatLibrary.Core.dll

Enumeration ColorType

Expand Down
5 changes: 2 additions & 3 deletions ...edMarkdown/CatLibrary.Core.ContainersRefType.ContainersRefTypeChild.verified.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
# Class ContainersRefTypeChild

_Namespace:_ [CatLibrary](CatLibrary.md).[Core](CatLibrary.Core.md)

_Assembly:_ CatLibrary.Core.dll
__Namespace:__ [CatLibrary](CatLibrary.md).[Core](CatLibrary.Core.md)
__Assembly:__ CatLibrary.Core.dll

```csharp
public class ContainersRefType.ContainersRefTypeChild
Expand Down
5 changes: 2 additions & 3 deletions ...n/CatLibrary.Core.ContainersRefType.ContainersRefTypeChildInterface.verified.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
# Interface ContainersRefTypeChildInterface

_Namespace:_ [CatLibrary](CatLibrary.md).[Core](CatLibrary.Core.md)

_Assembly:_ CatLibrary.Core.dll
__Namespace:__ [CatLibrary](CatLibrary.md).[Core](CatLibrary.Core.md)
__Assembly:__ CatLibrary.Core.dll

```csharp
public interface ContainersRefType.ContainersRefTypeChildInterface
Expand Down
5 changes: 2 additions & 3 deletions ...arkdown/CatLibrary.Core.ContainersRefType.ContainersRefTypeDelegate.verified.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
# Delegate ContainersRefTypeDelegate

_Namespace:_ [CatLibrary](CatLibrary.md).[Core](CatLibrary.Core.md)

_Assembly:_ CatLibrary.Core.dll
__Namespace:__ [CatLibrary](CatLibrary.md).[Core](CatLibrary.Core.md)
__Assembly:__ CatLibrary.Core.dll

Delegate ContainersRefTypeDelegate

Expand Down
5 changes: 2 additions & 3 deletions ...ot.Tests/SamplesTest.SeedMarkdown/CatLibrary.Core.ContainersRefType.verified.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
# Struct ContainersRefType

_Namespace:_ [CatLibrary](CatLibrary.md).[Core](CatLibrary.Core.md)

_Assembly:_ CatLibrary.Core.dll
__Namespace:__ [CatLibrary](CatLibrary.md).[Core](CatLibrary.Core.md)
__Assembly:__ CatLibrary.Core.dll

Struct ContainersRefType

Expand Down
5 changes: 2 additions & 3 deletions ....Tests/SamplesTest.SeedMarkdown/CatLibrary.Core.ExplicitLayoutClass.verified.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
# Class ExplicitLayoutClass

_Namespace:_ [CatLibrary](CatLibrary.md).[Core](CatLibrary.Core.md)

_Assembly:_ CatLibrary.Core.dll
__Namespace:__ [CatLibrary](CatLibrary.md).[Core](CatLibrary.Core.md)
__Assembly:__ CatLibrary.Core.dll

```csharp
public class ExplicitLayoutClass
Expand Down
5 changes: 2 additions & 3 deletions ...fx.Snapshot.Tests/SamplesTest.SeedMarkdown/CatLibrary.Core.Issue231.verified.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
# Class Issue231

_Namespace:_ [CatLibrary](CatLibrary.md).[Core](CatLibrary.Core.md)

_Assembly:_ CatLibrary.Core.dll
__Namespace:__ [CatLibrary](CatLibrary.md).[Core](CatLibrary.Core.md)
__Assembly:__ CatLibrary.Core.dll

```csharp
public static class Issue231
Expand Down
5 changes: 2 additions & 3 deletions ...x.Snapshot.Tests/SamplesTest.SeedMarkdown/CatLibrary.FakeDelegate`1.verified.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
# Delegate FakeDelegate

_Namespace:_ [CatLibrary](CatLibrary.md)

_Assembly:_ CatLibrary.dll
__Namespace:__ [CatLibrary](CatLibrary.md)
__Assembly:__ CatLibrary.dll

Fake delegate

Expand Down
5 changes: 2 additions & 3 deletions test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/CatLibrary.IAnimal.verified.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
# Interface IAnimal

_Namespace:_ [CatLibrary](CatLibrary.md)

_Assembly:_ CatLibrary.dll
__Namespace:__ [CatLibrary](CatLibrary.md)
__Assembly:__ CatLibrary.dll

This is <b>basic</b> interface of all animal.

Expand Down
5 changes: 2 additions & 3 deletions test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/CatLibrary.ICat.verified.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
# Interface ICat

_Namespace:_ [CatLibrary](CatLibrary.md)

_Assembly:_ CatLibrary.dll
__Namespace:__ [CatLibrary](CatLibrary.md)
__Assembly:__ CatLibrary.dll

Cat's interface

Expand Down
5 changes: 2 additions & 3 deletions ...fx.Snapshot.Tests/SamplesTest.SeedMarkdown/CatLibrary.ICatExtension.verified.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
# Class ICatExtension

_Namespace:_ [CatLibrary](CatLibrary.md)

_Assembly:_ CatLibrary.dll
__Namespace:__ [CatLibrary](CatLibrary.md)
__Assembly:__ CatLibrary.dll

It's the class that contains ICat interface's extension method.
<p>This class must be <b>public</b> and <b>static</b>.</p>
Expand Down
5 changes: 2 additions & 3 deletions ...x.Snapshot.Tests/SamplesTest.SeedMarkdown/CatLibrary.MRefDelegate`3.verified.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
# Delegate MRefDelegate

_Namespace:_ [CatLibrary](CatLibrary.md)

_Assembly:_ CatLibrary.dll
__Namespace:__ [CatLibrary](CatLibrary.md)
__Assembly:__ CatLibrary.dll

Generic delegate with many constrains.

Expand Down
Loading