Desk is a premium knowledge base and faq Jekyll theme
Desk was developed by Ivan Chromjak for jekyll.plus, theme live demo available.
Features
- Contact form
- Live Search
- Responsive videos
- Image lightbox
- Google maps
- Contact form (FormSpree)
- Pre-built pages
- Disqus comments for posts
- Configurable home page header images
- Optimised for GitHub pages
- RSS feed
- SEO tags
- Google Analytics
Installation
Install the dependencies with Bundler:
bundle install
Run the following to generate your site:
bundle exec jekyll serve
You can find more on Deployment Methods page on Jekyll website.
Setup
Site and author details
Add your site and author details in _config.yml:
# Site title and description
title: Desk - Helpdesk Jekyll Theme
description: Knowledge base Jekyll theme.
# Site base hostname & protocol, e.g. http://example.com
url: "https://desk.jekyll.plus"
# Site logo, image or text
brand:
image: logo.png # e.g. logo.png, upload logo image file to /assets/img/ folder
text: Desk # if the above "logo:" image variable is not set, this text logo is displayed instead
# Author settings
author:
name: Jim Smith
email: [email protected]
website: http://somewebsite.com
facebook: https://www.facebook.com/
flickr: https://flickr.com/
dribbble: https://dribbble.com/
github: https://github.com/
googleplus: https://plus.google.com/
instagram: https://www.instagram.com/
linkedin: https://www.linkedin.com/feed/
pinterest: https://www.pinterest.com/
twitter: https://twitter.com/
vimeo: https://vimeo.com/
youtube: https://www.youtube.com/
# Social share buttons
github_username: ivanchromjak
Navigation Bar
Set in the main navigation links in _data/navigation_header.yml:
- title: About
url: /about/
Footer
Edit copyright notice in _config.yml:
footer:
copyright:
Set in the navigation links in _data/navigation_footer.yml:
- title: About
url: /about/
Enabling comments (via Disqus)
Optionally, if you have a Disqus account, you can tell Jekyll to use it to show a comments section below each post. To enable it, add the following lines to your Jekyll site:
disqus:
shortname: my_disqus_shortname
You can find out more about Disqus' shortnames here.
Comments are enabled by default and will only appear in production, i.e., JEKYLL_ENV=production. If you don't want to display comments for a particular post you can disable them by adding comments: false to that post's YAML Front Matter.
Google Analytics
To enable Google Anaytics, add the following lines to your Jekyll site:
google_analytics: UA-NNNNNNNN-N
Google Analytics will only appear in production, i.e., JEKYLL_ENV=production
Google Map
To display Google map on contact page, add the following in your page content, replacing latitude, longitude and zoom values:
{% include map.html latitude="40.6700" longitude="-73.9400" zoom="16" %}
Contact Form (via FormSpree)
Submit the form and confirm your email address at FormSpree. Then add the following lines to contact page YAML Front Matter, replacing the email address:
formspree:
email: [email protected]
redirect: /thanks/
Update favicon
You can find the current favicon (favicon.png) inside the theme /assets/img/ directory, just replace it with your new favicon.
Posts
To create a new post, you can create a new markdown file inside the _posts directory by following the recommended file naming format:
YEAR-MONTH-DAY-title.MARKUP
Where YEAR is a four-digit number, MONTH and DAY are both two-digit numbers, and MARKUP is the file extension representing the format used in the file. For example, the following are examples of valid post filenames:
2011-12-31-new-years-eve-is-awesome.md
2012-09-12-how-to-write-a-blog.md
Post requires front matter, everything in between the first and second --- are part of the YAML Front Matter, and everything after the second --- will be rendered with Markdown and show up as “Content”. The following is a post file with different configurations you can add as example:
---
layout: post
title: How To Travel On Low Budget
---
You can rebuild the site in many different ways, but the most common way is to run bundle exec jekyll serve, which launches a web server and auto-regenerates your site when a file is updated.
To keep things more organized, add post images to /assets/posts/ directory, and add theme images to /assets/img/ directory.
Adding images
To add an image to a post or page use the following codes:
Local image from /assets/posts/ directory:
{% include image.html img="girl.jpg" alt="Alt for image" caption="Girl on a rock" %}
External wide image with lightbox:
{% include image.html img="https://source.unsplash.com/TT-ROxWj9nA.jpg" lightbox="true" alt="Alt for image" caption="Image in lightbox" %}
Adding table of contents
Add the following code at the top of the post:
#### Sections in this article
{:.no_toc}
* TOC
{:toc}
{:.no_toc} exludes #### Sections in this article title from indexing in table of contents
Responsive Videos
Embed local videos:
<video controls playsinline uk-video="automute: true">
<source src="http://www.quirksmode.org/html5/videos/big_buck_bunny.mp4" type="video/mp4">
<source src="http://www.quirksmode.org/html5/videos/big_buck_bunny.ogv" type="video/ogg">
</video>
Embed YouTube videos:
<iframe src="http://www.youtube.com/embed/YE7VzlLtp-4?autoplay=0&showinfo=0&rel=0&modestbranding=1&playsinline=1" width="600" height="340" frameborder="0" allowfullscreen uk-responsive uk-video="automute: true"></iframe>
To create a draft post, create the post file under the _drafts directory, and you can find more information in Working with Drafts.
Home Page
To create a home page, just create a index.md file inside the root directory. The following is a YAML Front Matter example for a page:
---
layout: help
title: How Can We Help You?
subtitle: Self Help Support
hero:
background: "#ffffff" # background color, note setting a background image below will overlay the background color
image: ocean.jpg # local image e.g ocean.jpg from /assets/posts/ folder or remote e.g https://source.unsplash.com/ZeXP6p7agjE
align: top # header image alignment e.g. top, center or bottom
text: dark # text color e.g. dark or light
search: true # enable search
category:
columns: 3 # number of category columns; 1, 2, 3, 4
featured:
title: Featured Articles
tag: featured # tag used to populate featured section on home page
---
Home page category boxes are added in _data/navigation_categories.yml, e.g.:
- heading: Browse All Topics
categories:
- title: Getting Started
desc: Get your account up and running in just few easy steps
icon: settings
- title: Account and Billing
desc: Managing your account, creating new users and exporting data
icon: credit-card
Faqs
To create a faq page, just create a new page inside the root directory and add the following code in content:
{% include faqs.html %}
Next create faq post entries in _faqs folder, similar to creating posts.
Customization
To modify the primary color, open /assets/css/main.scss and replace the #d40c3c color value:
// Primary template color
$global-primary-background: #d40c3c;
Further style customisation can be done in the following files:
/_sass/theme/mixins.scss
/_sass/theme/variables.scss
/assets/css/main.scss
Development
Install UIkit font end framework dependency via Npm:
npm install
Enable live browser reload with the following:
bundle exec jekyll s --livereload
Credits and Sources
- Google analytics https://www.google.com/analytics/
- Google maps https://www.google.com/maps
- UIkit front end framework https://getuikit.com/
- Unsplash images https://unsplash.com/
- Jekyll CML https://jekyllrb.com/
Support
Customer support is provided through our Envato profile page contact form for up to six months from the purchase date and is provided Monday to Friday during the business week. We aim to answer all support requests daily, most are handled within 48h.