Added git-repository-icon option
Updated documentation and added tests.
This commit is contained in:
parent
599e47f1f1
commit
5bfdf9fcc8
|
@ -149,6 +149,10 @@ The following configuration options are available:
|
||||||
- **playpen:** A subtable for configuring various playpen settings.
|
- **playpen:** A subtable for configuring various playpen settings.
|
||||||
- **search:** A subtable for configuring the in-browser search functionality.
|
- **search:** A subtable for configuring the in-browser search functionality.
|
||||||
mdBook must be compiled with the `search` feature enabled (on by default).
|
mdBook must be compiled with the `search` feature enabled (on by default).
|
||||||
|
- **git_repository_url:** A url to the git repository for the book. If provided
|
||||||
|
an icon link will be output in the menu bar of the book.
|
||||||
|
- **git_repository_icon:** The FontAwesome icon class to use for the git
|
||||||
|
repository link. Defaults to `fa-github`.
|
||||||
|
|
||||||
Available configuration options for the `[output.html.playpen]` table:
|
Available configuration options for the `[output.html.playpen]` table:
|
||||||
|
|
||||||
|
|
|
@ -440,8 +440,11 @@ pub struct HtmlConfig {
|
||||||
pub no_section_label: bool,
|
pub no_section_label: bool,
|
||||||
/// Search settings. If `None`, the default will be used.
|
/// Search settings. If `None`, the default will be used.
|
||||||
pub search: Option<Search>,
|
pub search: Option<Search>,
|
||||||
/// Git repository url. If 'None', the git button will not be shown.
|
/// Git repository url. If `None`, the git button will not be shown.
|
||||||
pub git_repository_url: Option<String>,
|
pub git_repository_url: Option<String>,
|
||||||
|
/// FontAwesome icon class to use for the Git repository link.
|
||||||
|
/// Defaults to `fa-github` if `None`.
|
||||||
|
pub git_repository_icon: Option<String>,
|
||||||
}
|
}
|
||||||
|
|
||||||
impl HtmlConfig {
|
impl HtmlConfig {
|
||||||
|
@ -573,6 +576,8 @@ mod tests {
|
||||||
curly-quotes = true
|
curly-quotes = true
|
||||||
google-analytics = "123456"
|
google-analytics = "123456"
|
||||||
additional-css = ["./foo/bar/baz.css"]
|
additional-css = ["./foo/bar/baz.css"]
|
||||||
|
git-repository-url = "https://foo.com/"
|
||||||
|
git-repository-icon = "fa-code-fork"
|
||||||
|
|
||||||
[output.html.playpen]
|
[output.html.playpen]
|
||||||
editable = true
|
editable = true
|
||||||
|
@ -610,6 +615,8 @@ mod tests {
|
||||||
additional_css: vec![PathBuf::from("./foo/bar/baz.css")],
|
additional_css: vec![PathBuf::from("./foo/bar/baz.css")],
|
||||||
theme: Some(PathBuf::from("./themedir")),
|
theme: Some(PathBuf::from("./themedir")),
|
||||||
playpen: playpen_should_be,
|
playpen: playpen_should_be,
|
||||||
|
git_repository_url: Some(String::from("https://foo.com/")),
|
||||||
|
git_repository_icon: Some(String::from("fa-code-fork")),
|
||||||
..Default::default()
|
..Default::default()
|
||||||
};
|
};
|
||||||
|
|
||||||
|
|
|
@ -455,8 +455,13 @@ fn make_data(
|
||||||
}
|
}
|
||||||
|
|
||||||
if let Some(ref git_repository_url) = html_config.git_repository_url {
|
if let Some(ref git_repository_url) = html_config.git_repository_url {
|
||||||
data.insert("git-repository-url".to_owned(), json!(git_repository_url));
|
data.insert("git_repository_url".to_owned(), json!(git_repository_url));
|
||||||
}
|
}
|
||||||
|
let git_repository_icon = match html_config.git_repository_icon {
|
||||||
|
Some(ref git_repository_icon) => git_repository_icon,
|
||||||
|
None => "fa-github",
|
||||||
|
};
|
||||||
|
data.insert("git_repository_icon".to_owned(), json!(git_repository_icon));
|
||||||
|
|
||||||
let mut chapters = vec![];
|
let mut chapters = vec![];
|
||||||
|
|
||||||
|
|
|
@ -113,9 +113,9 @@
|
||||||
<a href="{{ path_to_root }}print.html" title="Print this book" aria-label="Print this book">
|
<a href="{{ path_to_root }}print.html" title="Print this book" aria-label="Print this book">
|
||||||
<i id="print-button" class="fa fa-print"></i>
|
<i id="print-button" class="fa fa-print"></i>
|
||||||
</a>
|
</a>
|
||||||
{{#if git-repository-url}}
|
{{#if git_repository_url}}
|
||||||
<a href="{{git-repository-url}}" title="Git repository" aria-label="Git repository">
|
<a href="{{git_repository_url}}" title="Git repository" aria-label="Git repository">
|
||||||
<i id="github-button" class="fa fa-git"></i>
|
<i id="git-repository-button" class="fa {{git_repository_icon}}"></i>
|
||||||
</a>
|
</a>
|
||||||
{{/if}}
|
{{/if}}
|
||||||
</div>
|
</div>
|
||||||
|
|
Loading…
Reference in New Issue