/DocFx.Plugin.LastModified

A post-processor plugin for DocFX v2 that adds last modified date to conceptual articles.

Primary LanguageC#OtherNOASSERTION

Build status

DocFx.Plugin.LastModified

A DocFX plugin that adds a last modified date at the end of each conceptual articles.

Features

  • Adds last commit/modified date to each articles
  • Shows last commit message at the end of each articles

Prerequisites

  • Git for the target documentation
    • This does not require the host to install the git command, only version tracking for the project

But I don't track my changes with Git!

You are a mad man, but that's okay; the plugin will fallback to last modified date on the local machine when Git is not detected.

Setup

  1. Download the binaries from the AppVeyor artifacts linked above (or compile yourself).
  2. Create a new folder last-modified under your DocFX template folder.
  3. Create a new folder called plugins under last-modified.
  4. Drop the compiled binaries in.
  5. In your docfx.json file, modify your template section like so:
    "template": [
      "default",
      "_template/last-modified"
    ],
  1. Add the post-processor plugin like so:
    "postProcessors": ["LastModifiedPostProcessor"]
  1. Build the documentation, and it should work now!

Live Demo

This plugin is currently being used under Discord.Net Documentation.

License

This project is licensed under MIT; read LICENSE for more details.