https://github.com/kekyo/dockit

An automatic Markdown documentation generator, fetch from .NET XML comment/metadata.
https://github.com/kekyo/dockit

dotnet html markdown pandoc pdf xml-document

Last synced: 5 months ago
JSON representation

An automatic Markdown documentation generator, fetch from .NET XML comment/metadata.

• Host: GitHub
• URL: https://github.com/kekyo/dockit
• Owner: kekyo
• License: apache-2.0
• Created: 2023-07-28T06:30:28.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-08-30T00:53:02.000Z (over 2 years ago)
• Last Synced: 2025-04-04T12:51:37.462Z (10 months ago)
• Topics: dotnet, html, markdown, pandoc, pdf, xml-document
• Language: C#
• Homepage:
• Size: 114 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Dockit

![Dockit](Images/Dockit.100.png)

[![Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public.](https://www.repostatus.org/badges/latest/wip.svg)](https://www.repostatus.org/#wip)

[![NuGet Dockit](https://img.shields.io/nuget/v/Dockit.svg?style=flat)](https://www.nuget.org/packages/Dockit)

----

## What is this?

Dockit is an automatic Markdown documentation generator, fetch from .NET XML comment/metadata.

The advantage of Dockit is that it generates the document once in Markdown format

and then uses Pandoc to generate the document from Markdown.

This allows you to target a variety of output formats.

It is also much simpler to manage than other solutions,

as you simply install NuGet and it automatically generates the documentation for you.

TODO:

----

## Motivation

Unfortunately, in many (formal?) software development undertakings,

there are many projects that require documentation as a deliverable that is never read at all.

Modern software development environments, especially IDEs have improved greatly,

and source code parsing engines such as the Language Server Protocol,

allow help information to be displayed directly in the editor.

Interface specifications for software libraries are combined with metadata information and supplied by the LSP engine.

In the past, this same thing had to be done manually by humans, hence the reason for the existence of a "reference manual."

With this background, I do not see the value in increasing the output quality of this tool or making it more sophisticated.

Rather, I wanted to create a situation where the minimum effort is required to install only the NuGet package,

and the output is generated.

(Although care was taken to ensure that a certain level of documentation was generated)

It doesn't matter because no one will read it anyway.)

You just submit the reference document output by Dockit to your important (and not-so-important) customers :)

----

## License

Copyright (c) Kouji Matsui (@kozy_kekyo, @kekyo@mastodon.cloud)

License under Apache-v2.