Skip to content

Software for Documentations

Requirements

  • Must Be Portable and Cross Platform
  • Can be used online as well as offline
  • Ability to Version Control Document
  • Open Source or Free to Use
  • Easy To Learn and Maintain
  • Multiple Version of Document
  • Can be Ported to Multiple Format like PDF,HTML,Word

Tools Available

MkDocs

Overview

MkDocs is a fast, simple and downright gorgeous static site generator that's geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML configuration file.

Highlights

  • Project Documentation with Markdown
  • MkDocs is Static Site Generator using Markdown
  • Multiple Theme Available
  • Multiple Plugins for Markdown
  • Open source
  • Option to Preview Site while Writing using Built-in Dev server
  • Local Search Not Working

DocFx

Overview

DocFX is an API documentation generator for .NET, which currently supports C#, VB and F#. It generates API reference documentation from triple-slash comments in your source code. It also allows you to use Markdown files to create additional topics such as tutorials and how-tos, and to customize the generated reference documentation. DocFX builds a static HTML website from your source code and Markdown files, which can be easily hosted on any web server (for example, github.io).

Highlights

  • Supports Automatic API Documentation With Integration with Visual Studio
  • Project is Supported by Microsoft and implemented in Microsoft Docs
  • Cross-platform support. We have an exe version that runs natively on Windows and with Mono it can also run on Linux and macOS.
  • Markdown extensions. We introduced DocFX Flavored Markdown(DFM) to help you write API documentation. DFM is 100% compatible with GitHub Flavored Markdown(GFM) with some useful extensions, like file inclusion, code snippet, cross reference, and yaml header.
  • Local Search is Working with Edge but not working with Mozilla and Crome
  • Current Version 2 is Abandon Version 3 is still in development

Hosting Options

Read The Docs

  • Free Hosting
  • Host Multiple Version
  • Host Multiple Formats
  • webhooks so new documentation automatically Generated as soon as you push new commit

Github pages

  • Free
  • highly integrated with github

Own Server

  • Simply copy the contents of that directory to the root directory of your hosting provider's server and you are done.