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 1 commit
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
Prev Previous commit
Next Next commit
Fix tests
  • Loading branch information
@yufeih
yufeih committed Sep 21, 2023
commit e491edf2783608628d3241c5564f589cecda22b3
44 changes: 44 additions & 0 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
@@ -0,0 +1,44 @@
# Class Class1

_Namespace:_ [BuildFromAssembly](BuildFromAssembly.md)
_Assembly:_ BuildFromAssembly.dll

This is a test class.

```csharp
public class Class1
```

#### Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) ←
[Class1](BuildFromAssembly.Class1.md)

#### Inherited Members

[object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype),
[object.MemberwiseClone()](https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone),
[object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring),
[object.Equals(object?)](https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)),
[object.Equals(object?, object?)](https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)),
[object.ReferenceEquals(object?, object?)](https://learn.microsoft.com/dotnet/api/system.object.referenceequals),
[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode)

## Constructors

### Class1()

```csharp
public Class1()
```

## Methods

### HelloWorld()

Hello World.

```csharp
public static void HelloWorld()
```

36 changes: 36 additions & 0 deletions ...hot.Tests/SamplesTest.SeedMarkdown/BuildFromCSharpSourceCode.CSharp.verified.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Class CSharp

_Namespace:_ [BuildFromCSharpSourceCode](BuildFromCSharpSourceCode.md)
_Assembly:_ ?.dll

```csharp
public class CSharp
```

#### Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) ←
[CSharp](BuildFromCSharpSourceCode.CSharp.md)

#### Inherited Members

[object.Equals(object?)](https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)),
[object.Equals(object?, object?)](https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)),
[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode),
[object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype),
[object.MemberwiseClone()](https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone),
[object.ReferenceEquals(object?, object?)](https://learn.microsoft.com/dotnet/api/system.object.referenceequals),
[object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring)

## Methods

### Main(string[])

```csharp
public static void Main(string[] args)
```

#### Parameters

`args` [string](https://learn.microsoft.com/dotnet/api/system.string)[]

25 changes: 25 additions & 0 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
@@ -0,0 +1,25 @@
# Interface IIssue8948

_Namespace:_ [BuildFromProject](BuildFromProject.md)
_Assembly:_ BuildFromProject.dll

```csharp
public interface Class1.IIssue8948
```

## Methods

### DoNothing<T>()

Does nothing with generic type <code class="typeparamref">T</code>.

```csharp
void DoNothing<T>()
```

#### Type Parameters

`T`

A generic type.

100 changes: 100 additions & 0 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
@@ -0,0 +1,100 @@
# Class Issue8665

_Namespace:_ [BuildFromProject](BuildFromProject.md)
_Assembly:_ BuildFromProject.dll

```csharp
public class Class1.Issue8665
```

#### Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) ←
[Class1](BuildFromProject.Class1.md).[Issue8665](BuildFromProject.Class1.Issue8665.md)

#### Inherited Members

[object.Equals(object?)](https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)),
[object.Equals(object?, object?)](https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)),
[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode),
[object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype),
[object.MemberwiseClone()](https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone),
[object.ReferenceEquals(object?, object?)](https://learn.microsoft.com/dotnet/api/system.object.referenceequals),
[object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring)

## Constructors

### Issue8665()

```csharp
public Issue8665()
```

### Issue8665(int)

```csharp
public Issue8665(int foo)
```

#### Parameters

`foo` [int](https://learn.microsoft.com/dotnet/api/system.int32)

### Issue8665(int, char)

```csharp
public Issue8665(int foo, char bar)
```

#### Parameters

`foo` [int](https://learn.microsoft.com/dotnet/api/system.int32)

`bar` [char](https://learn.microsoft.com/dotnet/api/system.char)

### Issue8665(int, char, string)

```csharp
public Issue8665(int foo, char bar, string baz)
```

#### Parameters

`foo` [int](https://learn.microsoft.com/dotnet/api/system.int32)

`bar` [char](https://learn.microsoft.com/dotnet/api/system.char)

`baz` [string](https://learn.microsoft.com/dotnet/api/system.string)

## Properties

### Bar

```csharp
public char Bar { get; }
```

Property Value

[char](https://learn.microsoft.com/dotnet/api/system.char)

### Baz

```csharp
public string Baz { get; }
```

Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### Foo

```csharp
public int Foo { get; }
```

Property Value

[int](https://learn.microsoft.com/dotnet/api/system.int32)

85 changes: 85 additions & 0 deletions ...SamplesTest.SeedMarkdown/BuildFromProject.Class1.Issue8696Attribute.verified.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
# Class Issue8696Attribute

_Namespace:_ [BuildFromProject](BuildFromProject.md)
_Assembly:_ BuildFromProject.dll

```csharp
public class Class1.Issue8696Attribute : Attribute
```

#### Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) ←
[Attribute](https://learn.microsoft.com/dotnet/api/system.attribute) ←
[Class1](BuildFromProject.Class1.md).[Issue8696Attribute](BuildFromProject.Class1.Issue8696Attribute.md)

#### Inherited Members

[Attribute.Equals(object?)](https://learn.microsoft.com/dotnet/api/system.attribute.equals),
[Attribute.GetCustomAttribute(Assembly, Type)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute#system-attribute-getcustomattribute(system-reflection-assembly-system-type)),
[Attribute.GetCustomAttribute(Assembly, Type, bool)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute#system-attribute-getcustomattribute(system-reflection-assembly-system-type-system-boolean)),
[Attribute.GetCustomAttribute(MemberInfo, Type)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute#system-attribute-getcustomattribute(system-reflection-memberinfo-system-type)),
[Attribute.GetCustomAttribute(MemberInfo, Type, bool)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute#system-attribute-getcustomattribute(system-reflection-memberinfo-system-type-system-boolean)),
[Attribute.GetCustomAttribute(Module, Type)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute#system-attribute-getcustomattribute(system-reflection-module-system-type)),
[Attribute.GetCustomAttribute(Module, Type, bool)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute#system-attribute-getcustomattribute(system-reflection-module-system-type-system-boolean)),
[Attribute.GetCustomAttribute(ParameterInfo, Type)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute#system-attribute-getcustomattribute(system-reflection-parameterinfo-system-type)),
[Attribute.GetCustomAttribute(ParameterInfo, Type, bool)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute#system-attribute-getcustomattribute(system-reflection-parameterinfo-system-type-system-boolean)),
[Attribute.GetCustomAttributes(Assembly)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-assembly)),
[Attribute.GetCustomAttributes(Assembly, bool)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-assembly-system-boolean)),
[Attribute.GetCustomAttributes(Assembly, Type)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-assembly-system-type)),
[Attribute.GetCustomAttributes(Assembly, Type, bool)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-assembly-system-type-system-boolean)),
[Attribute.GetCustomAttributes(MemberInfo)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-memberinfo)),
[Attribute.GetCustomAttributes(MemberInfo, bool)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-memberinfo-system-boolean)),
[Attribute.GetCustomAttributes(MemberInfo, Type)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-memberinfo-system-type)),
[Attribute.GetCustomAttributes(MemberInfo, Type, bool)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-memberinfo-system-type-system-boolean)),
[Attribute.GetCustomAttributes(Module)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-module)),
[Attribute.GetCustomAttributes(Module, bool)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-module-system-boolean)),
[Attribute.GetCustomAttributes(Module, Type)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-module-system-type)),
[Attribute.GetCustomAttributes(Module, Type, bool)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-module-system-type-system-boolean)),
[Attribute.GetCustomAttributes(ParameterInfo)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-parameterinfo)),
[Attribute.GetCustomAttributes(ParameterInfo, bool)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-parameterinfo-system-boolean)),
[Attribute.GetCustomAttributes(ParameterInfo, Type)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-parameterinfo-system-type)),
[Attribute.GetCustomAttributes(ParameterInfo, Type, bool)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-parameterinfo-system-type-system-boolean)),
[Attribute.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.attribute.gethashcode),
[Attribute.IsDefaultAttribute()](https://learn.microsoft.com/dotnet/api/system.attribute.isdefaultattribute),
[Attribute.IsDefined(Assembly, Type)](https://learn.microsoft.com/dotnet/api/system.attribute.isdefined#system-attribute-isdefined(system-reflection-assembly-system-type)),
[Attribute.IsDefined(Assembly, Type, bool)](https://learn.microsoft.com/dotnet/api/system.attribute.isdefined#system-attribute-isdefined(system-reflection-assembly-system-type-system-boolean)),
[Attribute.IsDefined(MemberInfo, Type)](https://learn.microsoft.com/dotnet/api/system.attribute.isdefined#system-attribute-isdefined(system-reflection-memberinfo-system-type)),
[Attribute.IsDefined(MemberInfo, Type, bool)](https://learn.microsoft.com/dotnet/api/system.attribute.isdefined#system-attribute-isdefined(system-reflection-memberinfo-system-type-system-boolean)),
[Attribute.IsDefined(Module, Type)](https://learn.microsoft.com/dotnet/api/system.attribute.isdefined#system-attribute-isdefined(system-reflection-module-system-type)),
[Attribute.IsDefined(Module, Type, bool)](https://learn.microsoft.com/dotnet/api/system.attribute.isdefined#system-attribute-isdefined(system-reflection-module-system-type-system-boolean)),
[Attribute.IsDefined(ParameterInfo, Type)](https://learn.microsoft.com/dotnet/api/system.attribute.isdefined#system-attribute-isdefined(system-reflection-parameterinfo-system-type)),
[Attribute.IsDefined(ParameterInfo, Type, bool)](https://learn.microsoft.com/dotnet/api/system.attribute.isdefined#system-attribute-isdefined(system-reflection-parameterinfo-system-type-system-boolean)),
[Attribute.Match(object?)](https://learn.microsoft.com/dotnet/api/system.attribute.match),
[Attribute.TypeId](https://learn.microsoft.com/dotnet/api/system.attribute.typeid),
[object.Equals(object?)](https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)),
[object.Equals(object?, object?)](https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)),
[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode),
[object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype),
[object.MemberwiseClone()](https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone),
[object.ReferenceEquals(object?, object?)](https://learn.microsoft.com/dotnet/api/system.object.referenceequals),
[object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring)

## Constructors

### Issue8696Attribute(string?, int, int, string[]?, bool, Type?)

```csharp
[Class1.Issue8696("Changes the name of the server in the server list", 0, 0, null, false, null)]
public Issue8696Attribute(string? description = null, int boundsMin = 0, int boundsMax = 0, string[]? validGameModes = null, bool hasMultipleSelections = false, Type? enumType = null)
```

#### Parameters

`description` [string](https://learn.microsoft.com/dotnet/api/system.string)?

`boundsMin` [int](https://learn.microsoft.com/dotnet/api/system.int32)

`boundsMax` [int](https://learn.microsoft.com/dotnet/api/system.int32)

`validGameModes` [string](https://learn.microsoft.com/dotnet/api/system.string)[]?

`hasMultipleSelections` [bool](https://learn.microsoft.com/dotnet/api/system.boolean)

`enumType` [Type](https://learn.microsoft.com/dotnet/api/system.type)?

44 changes: 44 additions & 0 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
@@ -0,0 +1,44 @@
# Class Issue8948

_Namespace:_ [BuildFromProject](BuildFromProject.md)
_Assembly:_ BuildFromProject.dll

```csharp
public class Class1.Issue8948 : Class1.IIssue8948
```

#### Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) ←
[Class1](BuildFromProject.Class1.md).[Issue8948](BuildFromProject.Class1.Issue8948.md)

#### Implements

[Class1](BuildFromProject.Class1.md).[IIssue8948](BuildFromProject.Class1.IIssue8948.md)

#### Inherited Members

[object.Equals(object?)](https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)),
[object.Equals(object?, object?)](https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)),
[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode),
[object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype),
[object.MemberwiseClone()](https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone),
[object.ReferenceEquals(object?, object?)](https://learn.microsoft.com/dotnet/api/system.object.referenceequals),
[object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring)

## Methods

### DoNothing<T>()

Does nothing with generic type T.

```csharp
public void DoNothing<T>()
```

#### Type Parameters

`T`

A generic type.

28 changes: 28 additions & 0 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
@@ -0,0 +1,28 @@
# Class Test

_Namespace:_ [BuildFromProject](BuildFromProject.md)
_Assembly:_ BuildFromProject.dll

```csharp
public class Class1.Test<T>
```

## Type Parameters

`T`

#### Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) ←
[Class1](BuildFromProject.Class1.md).[Test](BuildFromProject.Class1.Test-1.md)<T>

#### Inherited Members

[object.Equals(object?)](https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)),
[object.Equals(object?, object?)](https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)),
[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode),
[object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype),
[object.MemberwiseClone()](https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone),
[object.ReferenceEquals(object?, object?)](https://learn.microsoft.com/dotnet/api/system.object.referenceequals),
[object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring)

Loading