https://github.com/whiteblackgoose/yadg.net

Naive documentation generator from the .NET compiler's output
https://github.com/whiteblackgoose/yadg.net

Last synced: about 1 month ago
JSON representation

Naive documentation generator from the .NET compiler's output

• Host: GitHub
• URL: https://github.com/whiteblackgoose/yadg.net
• Owner: WhiteBlackGoose
• License: mit
• Created: 2021-03-15T16:05:46.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2022-07-20T11:12:40.000Z (over 2 years ago)
• Last Synced: 2024-10-06T09:04:29.300Z (about 1 month ago)
• Language: C#
• Size: 82 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Yadg.NET

Yet Another Documentation Generator for .NET. Unlike others, it parses the output folder of a given project. Also,

it's not a program, it's a library (but easily can be used as a program).

## How to use

Set the output file:



Now, here's an example of the code:

```cs

new WebsiteBuilder(

        new PageSaver(@"D:/destination_path")

    )

    {

        MainPageName = "Full documentation of my project",

        MainPageDescription = @"


SomeDescription

"

    }

    .Build(

        DocsParser.Parse(

            "D:/my_project/bin/Release/netstandard2.0/Project.xml"

        ).Build()

    );

```


It does NOT build a ready-to-use website. Once generated, write a script which

would add a header and a footer to this. Maybe at some point I will add default

footer and header, but is the point of doing so?