https://github.com/still34/docfx.plugin.lastmodified

A post-processor plugin for DocFX v2 that adds last modified date to conceptual articles.
https://github.com/still34/docfx.plugin.lastmodified

conceptual-articles csharp docfx docfx-plugin

Last synced: 8 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/still34/docfx.plugin.lastmodified
• Owner: Still34
• License: other
• Created: 2018-05-05T09:45:56.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2024-07-09T07:15:29.000Z (4 months ago)
• Last Synced: 2024-11-01T02:42:52.342Z (15 days ago)
• Topics: conceptual-articles, csharp, docfx, docfx-plugin
• Language: C#
• Homepage:
• Size: 37.1 KB
• Stars: 7
• Watchers: 5
• Forks: 18
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Build status](https://ci.appveyor.com/api/projects/status/i58vkd8h4hiy6vhv?svg=true)](https://ci.appveyor.com/project/Still/docfx-plugin-lastmodified)

# 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:

```json

    "template": [

      "default",

      "_template/last-modified"

    ],

```

6. Add the post-processor plugin like so:

```json

    "postProcessors": ["LastModifiedPostProcessor"]

```

7. Build the documentation, and it should work now!

# Live Demo

This plugin is currently being used under [Discord.Net](https://github.com/RogueException/Discord.Net) [Documentation](https://docs.stillu.cc/).

# License

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