Code Monkey home page Code Monkey logo

docfx.plugin.lastmodified's Introduction

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.

docfx.plugin.lastmodified's People

Contributors

still34 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.