Docs: Doxy Jekyll Theme

Navigation will be visible in the top header area. You can control and edit the navigation from the _data/navigation.yml data file. The current navigation links are:

- title: home
  url: home
  submenu:
  - title: home gradient
    url: /home-gradient
  - title: home image
    url: /home-image
  - title: home video
    url: /home-video
- title: services
  url: services 
- title: screenshots
  url: screenshots
- title: pricing
  url: pricing
- title: team
  url: team
- title: blog
  url: blog
- title: contact
  url: contact

You can add a title and a URL for each navigation item for the website. For example, if you want to add a link to the about page, you can append the following to the list.

– title: about
url: /about

Open in New Tab

If you are having issue with category / tag then follow the tips bellow :

1) Check the post configuration and make sure you are using the correct settings make for tags and categories.

For Tag : tags For Category : categories

2) Check the text what you are using as category / tag. It should be english ( Bug Report Here : https://github.com/sverrirs/jekyll-paginate-v2/issues/171 )

3) Make sure you wrote your tags and category with comma separted.

Example :

tags: [wordpress, jekyll, ghost, themeix]

Open in New Tab

You need to change the shortname to use your own discuss comment system.

Open _includes/disqus_comment.html  or _includes/comments.html file, and change the XXXXX value on line number 15 with your Disqus account shortname.

s.src = '//XXXXX.disqus.com/embed.js';

So, if your Disqus shortname is example, the final code above should be

s.src = ‘//example.disqus.com/embed.js’;

<div id="disqus_thread"></div>
<script>

/**
*  RECOMMENDED CONFIGURATION VARIABLES: EDIT AND UNCOMMENT THE SECTION BELOW TO INSERT DYNAMIC VALUES FROM YOUR PLATFORM OR CMS.
*  LEARN WHY DEFINING THESE VARIABLES IS IMPORTANT: https://disqus.com/admin/universalcode/#configuration-variables*/
/*
var disqus_config = function () {
this.page.url = PAGE_URL;  // Replace PAGE_URL with your page's canonical URL variable
this.page.identifier = PAGE_IDENTIFIER; // Replace PAGE_IDENTIFIER with your page's unique identifier variable
};
*/
(function() { // DON'T EDIT BELOW THIS LINE
var d = document, s = d.createElement('script');
s.src = 'https://XXXXX.disqus.com/embed.js';
s.setAttribute('data-timestamp', +new Date());
(d.head || d.body).appendChild(s);
})();
</script>
<noscript>Please enable JavaScript to view the <a href="https://disqus.com/?ref_noscript">comments powered by Disqus.</a></noscript>
<script id="dsq-count-scr" src="//XXXXXX.disqus.com/count.js" async></script>

That’s all you need to setup Disqus from the theme side. If you get any issue feel free contact us.

Open in New Tab

We used gulp automated sytem in our template. Here following the details about Gulp Configuration.

How to add new script or remove script from minified css/js file?

We used a minified file to make the template faster and optimized. That file proceed by Gulp. So open the gulpfile.js and then you will find the following code there

    var CSS_Files = [	
	'./assets/css/bootstrap.min.css',
	'./assets/css/font-awesome.min.css',
	'./assets/css/slimmenu.min.css',
	'./assets/css/animate.min.css',
	'./assets/css/dark-theme.css',
	'./assets/css/owl.carousel.min.css',
	'./assets/css/rating.css'	 
    ];
    var JS_Files = [
	'./assets/js/jquery-3.3.1.min.js',
	'./assets/js/simple-jekyll-search.min.js',
	'./assets/js/jquery.slimmenu.min.js',
	'./assets/js/popper.min.js',
	'./assets/js/bootstrap.min.js',
	'./assets/js/owl.carousel.min.js',
	'./assets/js/wow.min.js',
	'./assets/js/rating.js',
	'./assets/js/parallax.min.js',
	'./assets/js/app.js'	
    ];

You can add or removed your script from there as your need.

And then use the command gulp in your command prompt area.

How to change the CSS / SCSS

That is very easy in our template. Just open the scss file what you want to change and then use the command gulp in your command prompt area. It will automatically update the app.min.css file

Here following a video tutorial about Doxy Jekyll theme installation and customization help :

If you still need help to setup Doxy Jekyll theme then feel free contact us

Open in New Tab

Navigation will be visible in the top header area. You can control and edit the navigation from the _data/navigation.yml data file. The current navigation links are:

- text: Home
  url: /
- text: Support
  url: /pages/support
- text: Blog
  url: /tag/education
  submenu:
  - text: Blog Left Sidebar
    url: /blog-post-left-sidebar
  - text: Blog Right Sidebar
    url: /blog-post-right-sidebar
  - text: Blog Details
    url: /technology-placeat-ipsum-libero
  - text: Post Tag Page
    url: /tag/education
- text: Docs
  url: /pages/explore-topics
  submenu:
  - text: Docs Left Sidebar
    url: /docs/left-sidebar-example
  - text: Docs Right Sidebar
    url: /docs/right-sidebar-example
  - text: Docs Fullwidth
    url: /docs/doc-fullwidth
- text: Pages
  url: /
  submenu:
  - text: Changelog
    url: /pages/changelog
  - text: Testimonials
    url: /pages/testimonials
  - text: Register
    url: /pages/register
  - text: Login
    url: /pages/login    
  - text: Privacy Policy
    url: /pages/privacy-policy    
  - text: FAQ
    url: /pages/faq 
  - text: Submit Ticket
    url: /pages/submit-ticket
- text: Contact
  url: /pages/contact

You can add a title and a URL for each navigation item for the website. For example, if you want to add a link to the about page, you can append the following to the list.

– title: about
url: /about

Open in New Tab

To create a new post in Doxy Jekyll Theme blog area, you should create a new markdown (.md) file inside the _posts directory or folder.  Here following a post example with different configurations for a blog post page.

---
layout: post
title: "Post Title Goes Here"
date: 2018-12-01 18:14:30 +0600
tags: [technology, education]
post_image: https://cdn.stocksnap.io/img-thumbs/960w/VJM1ZWXLPY.jpg
comment: true
excerpt: Here is the example of excerpt
---

You can easily change your sidebar position from the post layout option.

There are 2 post layout available in that theme. Use post_left for left sidebar and use only post for right sidebar layout

Open in New Tab

This theme comes with 8 different layouts and styles for the inner pages.

• default.html
• doc.html
• doc_full.html
• page.html
• post.html
• post_left.html
• tag_page.html

For the doc page you will find 2 different layout where you can choose to use sidebar or not. There have 2 different sidebar position layout for blog post.

Open in New Tab

Doxy themes comes with various customizations in the _config.yml file

# Site settings
title: "Doxy - Documentation Website"
email: "[email protected]"
description: "Doxy is a responsive Jekyll template for your documentation or knowledgebase website"
keywords: "jekyll, minimal jekyll, jekyll theme, responsive jekyll, seo friendly blog, super fast blog, responsive"
baseurl: "" # the subpath of your site, e.g. /blog
url: "https://doxy.netlify.com" # the base hostname & protocol for your site, e.g. http://example.com

## Theme Options
animated_header: ""  #true 
twitter_username: jekyllrb
github_username:  jekyll

# Tag Options
tag_page_layout: tag_page
tag_page_dir: tag

permalink: /:title/ 
 
collections:
  team_members:
    output: true
    permalink: /team_members/:path/
  testimonials:
    output: true
    permalink: /testimonials/:path/
  docs:
    output: true
    permalink: /docs/:path/

Open in New Tab

To run our jekyll theme locally, navigate to the theme directory from your PC and run bundle install command in git client app. to install the dependencies, then run bundle exec jekyll serve to start the Jekyll server.

Here following some good resources to deploy jekyll :

• Manual Deployment
• Automated Deployment (Example: Travis CI, Circle CI, Buddy etc)
• 3rd Party Deployment  (Example : Aerobatic, CloudCannon, Github Pages, Kickster, Netlify, Static Publisher)

Open in New Tab

Here is the details changelog of the Doxy Jekyll Template

V4.2.0 (05 Aug, 2020)
** Toc Plugin Changed ( For Github Enterprise Support )
[Added _includes/toc.html, modified layout/doc.html]


V4.1.0 (25 June, 2020)
** New sidebar added in Doc page
** Doc page controling system imporved and removed unnecessary layout file
** Sidebar design improved for TOC
** External Linking option added in doc page
** Documentation Improved ( Work in progress )


V4.0.0 (12 June, 2020)
** Jekyll 4.x.x Support
** Relative URL Support 
** Fixing URL Bug
** Improved layout for doc
** Improved Blog page

V3.0.0 (22 Sept, 2019)

** Doc Sidebar Changed For Better User Experience
** Sticky Doc Sidebar Added
** Page Title Background Changed to SVG
** Explore Topics Area Design Improved
** Un-necessary files removed
** Pagination Support for Blog
** Syntax Highlighter  Improved
** All the major hardcoded section changed to _data folder to generate dynamic data
** and many more improvement for better UX

V2.2.0 (03 July, 2019)

** Gulp integration
** Speed Optimization
** Concat, minify css and scripts

V2.1.0 (21 June, 2019)

** Search feature Added
** .html extension removed form the tag cloud
** Post count added in tag cloud in sidebar

V2.0.0 (28 Mar, 2019)

** Facebook Open Graph Meta Data added in Layout
** Twitter Card Meta Data added in Layout
** Author Image Source Linking bug fixed
** Doc Page's Sidebar Menu Accordion bug Fixed

V1.0.0 (13 Feb, 2019)

Initial Release

Open in New Tab

Doxy Jekyll is a multipurpose Jekyll theme to create an outstanding documentation website or support portal.  You will get a clean, polished and modern website with Doxy Jekyll Theme. It’s a ready website template for your support portal solution.

Doxy Jekyll built with  Jekyll Static Site Generator Framework. This theme as all necessary features for a support portal website. You will get tons of features and pages in that theme.  This theme has working Submit Ticket, Contact Form and Automatic Dorp Down menu features.

Open in New Tab