steve/just-the-docs
1
0
Fork 0
mirror of https://github.com/snachodog/just-the-docs.git synced 2025-04-22 02:52:23 -06:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source 
* 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: Peter Mosses <18308236+pdmosses@users.noreply.github.com>
This commit is contained in:
Matt Wang 2022-12-13 11:21:20 -08:00 committed by GitHub
parent cf5aa7334f
commit 845cd763f3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 12 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
_includes/favicon.html
View File

@ -1 +0,0 @@
<link rel="shortcut icon" href="{{ 'favicon.ico' | relative_url }}" type="image/x-icon">

2
_includes/head.html
View File

@ -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 %}

1
_includes/head_custom.html
View File

@ -0,0 +1 @@
<link rel="shortcut icon" href="{{ 'favicon.ico' | relative_url }}" type="image/x-icon">

14
docs/customization.md
View File

@ -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`