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

Updated the README file

main
Wynd 2023-07-09 12:41:41 +03:00
parent 78606b8e67
commit dac759ceea
1 changed files with 13 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -10,7 +10,6 @@ It uses the configured `git-repository-url` as the base.
## Requirements ## Requirements
* The `git` command line tool. * 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. * Access to the git repository checkout while building your book.
## Installation ## Installation
@ -36,10 +35,22 @@ renderer = ["html"]
```toml ```toml
[output.html] [output.html]
# Required: Your repository URL used in the link. # Optional: Your repository URL used in the link.
git-repository-url = "https://github.com/$user/$project" git-repository-url = "https://github.com/$user/$project"
``` ```
If `git-repository-url` is not configured the footer will not contain the commit and a link to it and instead only show the last changed date.
Without `git-repository-url` configured:
```HTML
<footer id="last-change">Last change: 2023-07-09</footer>
```
With `git-repository-url` configured:
```HTML
<footer id="last-change">Last change: 2023-07-09, commit: <a href="https://github.com/$user/$project/commit/$commit">0000000</a></footer>
```
To style the footer add a custom CSS file for your HTML output: To style the footer add a custom CSS file for your HTML output:
```toml ```toml