#mdbook #last #date

bin+lib mdbook-last-changed

mdbook preprocessor to add the last modification date per page

3 releases

0.1.2 Dec 18, 2022
0.1.1 Nov 1, 2022
0.1.0 Nov 1, 2022

#396 in Text processing

Download history 9/week @ 2022-12-07 35/week @ 2022-12-14 16/week @ 2022-12-21 19/week @ 2022-12-28 14/week @ 2023-01-04 17/week @ 2023-01-11 16/week @ 2023-01-18 18/week @ 2023-01-25 19/week @ 2023-02-01 19/week @ 2023-02-08 29/week @ 2023-02-15 21/week @ 2023-02-22 18/week @ 2023-03-01 12/week @ 2023-03-08 25/week @ 2023-03-15 19/week @ 2023-03-22

78 downloads per month

MPL-2.0 license

25KB
178 lines

mdbook-last-changed

A preprocessor for mdbook to add a page's last change date and a link to the commit on every page.

It adds a "Last change" footer, including a date and a link to the corresponding commit. It uses the configured git-repository-url as the base.

Requirements

  • The git command line tool.
  • A configured git repository url in your book.toml configuration. See Configuration.
  • Access to the git repository checkout while building your book.

Installation

If you want to use only this preprocessor, install the tool:

cargo install mdbook-last-changed

Add it as a preprocessor to your book.toml:

[preprocessor.last-changed]
command = "mdbook-last-changed"
renderer = ["html"]

Configuration

mdbook-last-changed is configured using additional options under [output.html]:

[output.html]
# Required: Your repository URL used in the link.
git-repository-url = "https://github.com/$user/$project"

To style the footer add a custom CSS file for your HTML output:

[output.html]
additional-css = ["last-changed.css"]

And in last-changed.css style the <footer> element or directly the CSS element id last-changed:

footer {
  font-size: 0.8em;
  text-align: center;
  border-top: 1px solid black;
  padding: 5px 0;
}

This code block shrinks the text size, center-aligns it under the rest of the content and adds a small horizontal bar above the text to separate it from the page content.

Finally, build your book as normal:

mdbook path/to/book

License

MPL. See LICENSE.
Copyright (c) 2022 Jan-Erik Rediger janerik@fnordig.de

Dependencies

~8–40MB
~680K SLoC