Skip to content
master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 

EarlyDocs

EarlyDocs generates Markdown documentation for your .Net library.

Install the EarlyDocs NuGet package to insert EarlyDocs into your build process. It will run after your project build is complete. Errors in EarlyDocs will not affect your build.

EarlyDocs is built on top of WithoutHaste.DataFiles.

Download

Available on Nuget.

Package Manager: Install-Package EarlyDocs -Version 2.0.0

.NET CLI: dotnet add package EarlyDocs --version 2.0.0

Documentation

To get started with EarlyDocs:
Installing and Using EarlyDocs

About using Xml Comments:
How to Use Xml Comments

For programmers on this project:
Design

Examples

Projects with EarlyDocs-generated documentation.

WithoutHaste.DataFiles

WithoutHaste.Drawing.Colors

WithoutHaste.Drawing.Shapes

WithoutHaste.Windows.GUI

The EarlyDocs test project includes examples of almost everything:
EarlyDocs test project documentation

License

MIT License

Donate

Become a patron of this and other Without Haste open source projects.

Version Notes

Uses Semantic Versioning 2.0.0.

v2.0.0

  • Fixed path error that caused process to fail.
  • Project is now multi-targeted for all .Net frameworks from 2.0 through 4.7.2.

Initial Release - v1.0.0

About

XML to MD documentation converter for Visual Studio XML documentation. Includes documentation of object structure.

Resources

License

Packages

No packages published