Doraku / DefaultDocumentation

Create a simple markdown documentation from the Visual Studio xml one.
MIT No Attribution
157 stars 26 forks source link

Generate YAML front-matter for Jekyll #95

Closed IdkGoodName closed 2 years ago

IdkGoodName commented 2 years ago

Currently, DefaultDocumentation only generates plain Markdown document without any YAML front-matter. This can be bothering if you use any SSG like Jekyll to document your library.

Current page generation:

### [X](...)
## [X.Y](...)
# [X.Y.Z](...)

Summary
```csharp
public class Z : α

Suggested page generation:
````markdown
---
title: X.Y.Z
member_type: class
description: >
  Summary
definition: >
  public class Z : α
---
### [X](...)
## [X.Y](...)
# [X.Y.Z](...)

Summary
```csharp
public class Z : α


Perhaps even possibly allow setting which properties to add.
Doraku commented 2 years ago

With the new feature allowing you to add custom sections, you should be able to add just that. I am still cleaning up some stuff and adding documentation to the api but a plugin example of how to add new features should arrive soon.

Doraku commented 2 years ago

I added in the samples an example of a basic custom section, you could use that to prefix all your pages with what you need.