From dac759ceea353c408cd27ee295986d31cd1b2011 Mon Sep 17 00:00:00 2001 From: Wynd Date: Sun, 9 Jul 2023 12:41:41 +0300 Subject: [PATCH] Updated the README file --- README.md | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 9f17528..f7cbe9c 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,6 @@ 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 @@ -36,10 +35,22 @@ renderer = ["html"] ```toml [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" ``` +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 + +``` + +With `git-repository-url` configured: +```HTML + +``` + To style the footer add a custom CSS file for your HTML output: ```toml