Skip to content
Snippets Groups Projects
Unverified Commit 845cd763 authored by Matt Wang's avatar Matt Wang Committed by GitHub
Browse files

Removes `favicon.html`, shifts content to `head_custom.html` (#1027) 


* Removes `favicon.html`, shifts content to `head_custom.html`
* explicit callout for custom favicon in customization docs
* Cleaner and more consistent documentation (review from @pdmosses)

Co-authored-by: default avatarPeter Mosses <18308236+pdmosses@users.noreply.github.com>
parent cf5aa733
No related branches found
No related tags found
No related merge requests found
Hide whitespace changes
Inline Side-by-side
_includes/favicon.html deleted 100644 → 0
+ 0
− 1
View file @ cf5aa733
<link rel="shortcut icon" href="{{ 'favicon.ico' | relative_url }}" type="image/x-icon">
_includes/head.html
+ 0
− 2
View file @ 845cd763
...@@ -2,8 +2,6 @@ ...@@ -2,8 +2,6 @@
<meta charset="UTF-8"> <meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=Edge"> <meta http-equiv="X-UA-Compatible" content="IE=Edge">
{% include favicon.html %}
<link rel="stylesheet" href="{{ '/assets/css/just-the-docs-default.css' | relative_url }}"> <link rel="stylesheet" href="{{ '/assets/css/just-the-docs-default.css' | relative_url }}">
{% if site.ga_tracking != nil %} {% if site.ga_tracking != nil %}
......
_includes/head_custom.html
+ 1
− 0
View file @ 845cd763
<link rel="shortcut icon" href="{{ 'favicon.ico' | relative_url }}" type="image/x-icon">
docs/customization.md
+ 11
− 3
View file @ 845cd763
...@@ -168,20 +168,28 @@ The (optional) `text-delta` class makes the heading appear as **Contents**{:.tex ...@@ -168,20 +168,28 @@ The (optional) `text-delta` class makes the heading appear as **Contents**{:.tex
This content appears at the bottom of every page's main content. More info for this include can be found in the [Configuration - Footer content]({{ site.baseurl }}{% link docs/configuration.md %}#footer-content). This content appears at the bottom of every page's main content. More info for this include can be found in the [Configuration - Footer content]({{ site.baseurl }}{% link docs/configuration.md %}#footer-content).
### Custom Head ### Custom Head and Favicon
`_includes/head_custom.html` `_includes/head_custom.html`
Any HTML added to this file will be inserted before the closing `<head>` tag. This might include additional `<meta>`, `<link>`, or `<script>` tags. Any HTML added to this file will be inserted before the closing `<head>` tag. This might include additional `<meta>`, `<link>`, or `<script>` tags.
#### Example Note that by default, this file has the following contents:
```html
<link rel="shortcut icon" href="{{ 'favicon.ico' | relative_url }}" type="image/x-icon">
```
#### Example: Custom Favicon
{: .no_toc } {: .no_toc }
To add a custom favicon, create `_includes/head_custom.html` and add: To add a custom favicon, create `_includes/head_custom.html` and add:
```html ```html
<link rel="shortcut icon" type="image/png" href="{{site.baseurl}}/path/to/your/favicon.png"> <link rel="shortcut icon" href="{{ 'favicon.ico' | relative_url }}" type="image/x-icon">
``` ```
If *no favicon* is desired, one needs to have a *blank* `_includes/head_custom.html`.
### Custom Header ### Custom Header
`_includes/header_custom.html` `_includes/header_custom.html`
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment