wynd
/
mdbook-last-changed
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Document Requirements

main
Jan-Erik Rediger 2022-11-01 18:45:55 +01:00
parent 852ed9a926
commit 9c3b12e82b
1 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -7,6 +7,12 @@ A preprocessor for [mdbook][] to add a page's last change date and a link to the
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](#configuration).
* Access to the git repository checkout while building your book.
## Installation
If you want to use only this preprocessor, install the tool: