Skip to content

Instantly share code, notes, and snippets.

@TheAngryByrd

TheAngryByrd/dotnet-oss-documentation-tools.md

Created October 31, 2021 19:55
Show Gist options
  • Save TheAngryByrd/67cf022be6493c7ac2dbd11fceec83be to your computer and use it in GitHub Desktop.
Save TheAngryByrd/67cf022be6493c7ac2dbd11fceec83be to your computer and use it in GitHub Desktop.
Download ZIP
.NET OSS documentation tools
Raw
dotnet-oss-documentation-tools.md

.NET OSS Documentation tools

Criteria

  • What dependencies does it require? (npm, netfx, dotnet-core)
  • Does it seem to be maintained?
  • Does it have a good update story?
  • How easy is it to get started? (good tutorial, templating)
  • Can I change the structure easily to fit the divio structure?
  • Does it support search? Is the search useful?
  • Does it handle versioning?
    • Does it show which git-tag/version this documenation was generated for?
  • Does it handle multi-lingual?
  • Does it handle hot reloading of markdown->html?
  • Can it generate pages from XML Doc comments?
    • Which language(s) does it support? (C#, F#, VB)
    • Can it hotload changes from doc comments?
    • Does it put a github link on the type/method/function to where the code is?
    • Does it handle tags like exception, example, see, returns, params, summary, remarks?
    • Does it handle obsolete, requirequalifiedaccess or other attributes?
  • Can it easily pull in project metadata like CHANGELOG, README, LICENSE, etc?
  • Does it let a user fix problems with documentation easily (having a link to the markdown file)?
  • Does it support multiple css templates (light/dark mode)?

List of documenation tools to review

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment