steve/just-the-docs
1
0
Fork 0
mirror of https://github.com/snachodog/just-the-docs.git synced 2025-04-17 16:42:24 -06:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #364 from burner1024/custom-favicon

Browse Source 
allow custom favicon code
This commit is contained in:
Patrick Marsceill 2022-03-03 15:36:32 -05:00 committed by GitHub
commit 6f8ae3e97e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 22 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
_includes/favicon.html Normal file
View File

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

2
_includes/head.html
View File

@ -10,7 +10,7 @@
{% endif %} {% endif %}
{% endunless %} {% endunless %}
<link rel="shortcut icon" href="{{ 'favicon.ico' | relative_url }}" type="image/x-icon"> {% 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 }}">

6
index.md
View File

@ -35,34 +35,28 @@ remote_theme: just-the-docs/just-the-docs
### Local installation: Use the gem-based theme ### Local installation: Use the gem-based theme
1. Install the Ruby Gem 1. Install the Ruby Gem
```bash ```bash
$ gem install just-the-docs $ gem install just-the-docs
``` ```
```yaml ```yaml
# .. or add it to your your Jekyll site’s Gemfile # .. or add it to your your Jekyll site’s Gemfile
gem "just-the-docs" gem "just-the-docs"
``` ```
2. Add Just the Docs to your Jekyll site’s `_config.yml` 2. Add Just the Docs to your Jekyll site’s `_config.yml`
```yaml ```yaml
theme: "just-the-docs" theme: "just-the-docs"
``` ```
3. _Optional:_ Initialize search data (creates `search-data.json`) 3. _Optional:_ Initialize search data (creates `search-data.json`)
```bash ```bash
$ bundle exec just-the-docs rake search:init $ bundle exec just-the-docs rake search:init
``` ```
3. Run you local Jekyll server 3. Run you local Jekyll server
```bash ```bash
$ jekyll serve $ jekyll serve
``` ```
```bash ```bash
# .. or if you're using a Gemfile (bundler) # .. or if you're using a Gemfile (bundler)
$ bundle exec jekyll serve $ bundle exec jekyll serve