Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
C
Community Documentation
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Container Registry
Model registry
Operate
Environments
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Bio-IT
Community Documentation
Commits
91760ee8
Commit
91760ee8
authored
5 years ago
by
Silvio Giebl
Browse files
Options
Downloads
Patches
Plain Diff
Added documentation for logo variable
parent
132cecfe
No related branches found
No related tags found
No related merge requests found
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
_config.yml
+3
-1
3 additions, 1 deletion
_config.yml
docs/configuration.md
+14
-8
14 additions, 8 deletions
docs/configuration.md
with
17 additions
and
9 deletions
_config.yml
+
3
−
1
View file @
91760ee8
...
...
@@ -17,11 +17,13 @@ title: Just the Docs
description
:
A Jekyll theme for documentation
baseurl
:
"
/just-the-docs"
# the subpath of your site, e.g. /blog
url
:
"
https://pmarsceill.github.io"
# the base hostname & protocol for your site, e.g. http://example.com
#logo: "/assets/images/just-the-docs.png"
permalink
:
pretty
exclude
:
[
"
node_modules/"
,
"
*.gemspec"
,
"
*.gem"
,
"
Gemfile"
,
"
Gemfile.lock"
,
"
package.json"
,
"
package-lock.json"
,
"
script/"
,
"
LICENSE.txt"
,
"
lib/"
,
"
bin/"
,
"
README.md"
,
"
Rakefile"
]
# Set a path/url to a logo that will be displayed instead of the title
#logo: "/assets/images/just-the-docs.png"
# Enable or disable the site search
search_enabled
:
true
...
...
This diff is collapsed.
Click to expand it.
docs/configuration.md
+
14
−
8
View file @
91760ee8
...
...
@@ -22,11 +22,18 @@ Just the Docs has some specific configuration parameters that can be defined in
View this site's
[
_config.yml
](
https://github.com/pmarsceill/just-the-docs/tree/master/_config.yml
)
file as an example.
## Search enabled
## Site logo
```
yaml
# Set a path/url to a logo that will be displayed instead of the title
logo
:
"
/assets/images/just-the-docs.png"
```
## Search
```
yaml
# Enable or disable the site search
# Support true (default) or false
# Support
s
true (default) or false
search_enabled
:
true
```
...
...
@@ -35,18 +42,17 @@ search_enabled: true
```
yaml
# Aux links for the upper right navigation
aux_links
:
"
Just
the
Docs
on
GitHub"
:
-
"
//github.com/pmarsceill/just-the-docs"
"
Just
the
Docs
on
GitHub"
:
-
"
//github.com/pmarsceill/just-the-docs"
```
## Heading anchor links
```
yaml
# Heading anchor links appear on hover over h1-h6 tags
# in page content allowing users to deep link to a particular
# heading on a page.
# Heading anchor links appear on hover over h1-h6 tags in page content
# allowing users to deep link to a particular heading on a page.
#
# Supprts true (default) or false/nil
# Supp
o
rts true (default) or false/nil
heading_anchors
:
true
```
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment