Docslab Documentation

Getting Started

Docslab is a knowledge base and documentation ghost theme. It is very useful and helpful for software, SASS application, and other platform documentation. Anyone can make documentation for his product using this. We created this documentation theme with a minimal design and the best user experience. It will give your user the best readability experience and will help to focus on the targeted points of your applications.

Support

If you have any questions that are beyond the scope of this help file, please feel free to send your questions to our support email: support@electronthemes.com Our support team will reply you within 6 hours.

Template Information

• Name: Docslab
• Author: Electronthemes
• Platform: Ghost
• Demo: Docslab
• Created: 28 Sept 2020
• Last Update: 14 July 2021 See Changelog
• Version: 2.2.0

Features

General Features

• 100% responsive design for all devices
• W3 validation code
• 2 Google fonts
• Very light-weight theme
• Fast loading
• SVG icons
• Easily customizable
• SASS supported
• Well written documentation
• Supported with image and without images
• Translation Ready

Ghost inbuilt features

• Ghost supported v4.0.0
• Publication and Description
• Publication cover
• Publication logo and icon
• Social accounts
• Koenig Editor
• Primary Navigation
• Secondary Navigation
• General posts and pages
• Tags
• Authors
• Responsive Content
• Gallery
• Bookmark
• HTML code
• Code Highlighter
• Share posts on social media
• Post Navigation
• Load more options
• Translation ready to other language
• Subscription features
• Membership
• Signin
• Signup
• Notifications

Pages

• Homepage
• Post page
• Tag page
• Author page
• Error
• Page
• Error-404

Custom Pages

• Custom Author list
• Custom Tag list
• Custom Contact
• Custom Account
• Custom Membership
• Custom Signin
• Custom Signup
• Custom Changelog
• Custom Post Fullwidth
• Custom Post Fullwidth Image

Additional Ghost Features

• Disqus comment box
• Table of contents
• Custom Alert box
• Bredcrumb navigation
• Faq feature
• Custom Contact promo
• Help desk authors
• About section
• Beautiful footer
• Documentation load more button
• Tag list sidebars
• Copy url with click
• Formspree for contact form
• Medium zoom
• Mobile menu support
• SVG logo
• Syntax highlighting
• Custom buttons
• Dark Light Mode

Theme Setup

Docslab theme setup is very easy. If you have already installed a server for Ghost you can easily setup Docslab theme. If you don’t have a server supported with Ghost, you can set up reading Ghost Install. When you have the server, follow the instructions for setting up the theme.

Upload the theme

You can upload the theme file from ghost dashboard. to do this

• Log in into your Ghost admin panel.
• Go to Dashboard > Settings Icon > Design > Change theme > Upload theme > and upload
• Click Activate.

Uploading the theme via (FTP)

Follow the instructions

• Login to your FTP account.
• Unzip the docslab.zip file and copy docslab folder to your /ghost_installation/content/themes
• Restart your installation if necessary. You can ask for help from your hosting provider if you don’t know how to do this step.
• Login to your ghost admin panel.
• Go to settings (general) and select theme “Docslab“
• Click Save.

General Setup

Publication Info

To change publication info, go to Dashboard > Settings Icon > General > Publication Info. Here you can change the following:

• Title
• Description
• Site Timezone
• Publication Language

Favicon Icon

Ghost shows his ghost logo in your site by default. You can change Favicon Icon or Publication Icon from Dashboard > Settings Icon > Design > Publication Icon

Logo

We have used SVG Logo for the theme . You can change SVG Logo from Dashboard > Settings Icon > Design > Publication Logo

Publication Cover

This is for showing site bookmark image. If you upload a cover image, it will in your site bookmark or go to Dashboard > Settings Icon > Design > Publication Cover

Site Meta Settings

This is for Meta data. It will help to get on search using search engine. You can add also Twitter and Facebook card image, content here.

You can add/edit the content from Dashboard > Settings Icon > General > Site Meta Settings

Social Accounts

Social account section is for showing Facebook, Twitter links of your site. Go to Dashboard > Settings Icon > General > Social Accounts

Primary Navigation

Ghost only support two types of Navigation. Primary and Secondary Navigation Menu. On header, primary navigation is showing and On Footer secondary navigation is showing. Go to Dashboard > Settings Icon > Navigation

Secondary Navigation

Secondary Navigation is showing at footer. To add Secondary menu item, go to Dashboard > Settings Icon > Navigation

Create a Post

Ghost has a beautiful dashboard design. You can easily create a post. Go to Dashboard > Posts > New Post

• Post Title
• Post Contents
• Feature image
• Tags
• Authors

Create a page

As like as post, you can create a new page from Dashboard > Pages > New Page. You can add:

• Title
• Contents
• Tags
• Authors
• Feature Image
• Excerpt
• more…

Create Tag

To create a new tag, go to Dashboard > Tags > New Tag

Create Author

You can create multiple authors in your site from the dashboard. Go to Dashboard > Settings Icon > Stuff > Invite people

Click on Invite people and you will get a new popup. You have to add Email Address and select the staff Role. Lastly click on Send Invitation now button. An email notification will be sent to create an account on the specific Role.

Code Injection

Code injection is a great feature on Ghost. You can easily write styles and scripts for your site without editing the theme file. You can add various plugins code here like Google analytics

Here you will two text field for code injections. 1. Site Header and 2. Site Footer

Go to Dashboard > Settings Icon > Code Injection

Site Header

If you write scripts on site header, it will show in <head> tag of header. It will load first in your site

Site Footer

If you write scripts on site footer, it will show at the closing of <body> tag. It will load last in your site

Integrations and Custom Integrations

Integrations are another cool feature of Ghost. You can connect a lot of thirdparty plugins or API using integrations. To check the integrations, go to Dashboard > Settings Icon > Integrations. You will get some inbuilt integrations and custom integrations options

Custom integrations

To create custom integrations, click on + Add custom integration at the bottom of the page and you will get a popup and add a name of the integration and Create. I have create here Search and Github Deploy integration

Labs

Labs is another very important and beta tester parts of Ghost. Here your will get some core features as follows: Go to Dashboard > Settings Icon > Labs

1. Import Content
2. Export your content
3. Delete All Content
4. Tiers
5. Redirects
6. Routes

Routes

Routes is another important part. When you want to use different path link or custom files for pages and different homepage, you can use routes.yaml file to do that. Here is default .yaml for ghost.

routes:

collections:
  /:
    permalink: /{slug}/
    template: index

taxonomies:
  tag: /tag/{slug}/
  author: /author/{slug}/

Header

For header, we have used {{> header}} partials in folder partials/ header.hbs. In this file you can change the followings:

1. Logo
2. Primary Navigation
3. Gihub Icon
4. Dark Light Icon

To change the logo markup or text, find this structure on header.hbs file

{{#if @site.logo}}
    <a href="{{@site.url}}">
        <img src="{{@site.logo}}" alt="logo-img">
    </a>
{{else}}
    <h2><a href="{{@site.url}}">{{@site.title}}</a></h2>
{{/if}}

Primary Navigation

For Primary navigation, go to Dashboard > Design > Primary Navigation

Signin and Subscribe button is coming from {{> members/header-members-details}} partials. If you want to remove these link, just comment or remove this from line number 23 of header.hbs

Github and Dark-Light Icons

You can change it on header.hbs file. Go to line number 46 and you will get this markup

{{!-- light-dark version --}}
<div class="promo-icon">
    <div class="github-profile">
        <a href="https://github.com/">
            {{> icons/github}}
        </a>
    </div>
    <div class="dark-light">
        <div class="icon-dark">
            {{> icons/light}}
        </div>
        <div class="icon-light">
            {{> icons/dark}}
        </div>
    </div>
</div>

If you want to change icons, add icon in partials/icons folder and link it as like as this partials {{> icons/github}}

Footer

In footer, we have used some widgets. You will get the text and contents to change in file footer.hbs in the location partials/footer.hbs. Here you will get:

1. About texts
2. Recent Documentation
3. Secondary Navigation
4. Social profile links
5. Footer copyright texts

About Text

To change about text, go to line number 6 of footer.hbs file and you will see the following markup

<div class="footer-widget">
    <h4>{{t "About"}}</h4>
    <p>{{t "Electronthemes is a digital agency where we provide solutions for Ghost themes, WordPress themes, Front-End development. We are a team of some very talentend designers, Engineers and Marketers"}}</p>
</div>

Recent Documentation

We have showed only 4 recent documentation. If you want to increase or decrease the limit, change limit="4" at line number 17 of footer.hbs file.

{{#foreach tags limit="4" visibility="public"}}

Footer links

Yon change footer links from Dashboard > Settings Icon > Navigation. If you want to remove or change title text, edit line number 34 in footer.hbs file.

{{#if @site.secondary_navigation}}
<div class="col-md-6 col-lg-3 footer-widget-box">
    <div class="footer-widget">
        <h4>{{t "Links"}}</h4>
        {{navigation type="secondary"}}
    </div>
</div>
{{/if}}

Social Profiles

For changing social profiles link on footer, go to line number 47 on footer.hbs file and edit the following links.

<ul>
    {{#if @site.facebook}}
    <li><a href="{{facebook_url}}">{{t "Facebook"}}</a></li>
    {{/if}}
    {{#if @site.twitter}}
    <li><a href="{{twitter_url}}">{{t "Twitter"}}</a></li>
    {{/if}}
    <li><a href="#">{{t "linkedin"}}</a></li>
    <li><a href="#">{{t "Instagram"}}</a></li>
    <li><a href="#">{{t "Youtube"}}</a></li>
    <li><a href="#">{{t "Unsplash"}}</a></li>  
    <li><a href="{{@site.url}}/rss">{{t "RSS"}}</a></li>
</ul>

Footer Copyright

At the very bottom of footer, you will get footer copyright text. Go to line number 70 of footer.hbs file. You will get the following line

<p>{{t "All copyright reserved by Electronthemes. Published with "}}<a href="https://ghost.org/">{{t "Ghost"}}</a></p>

Homepage

In the homepage, you will see come custom texts and contents. We will show you show to change this

Cover section

Here you can change site title and description from Dashboard > Settings Icon > Design > Site Identity. If you want to change Welcome to text, go to partials/hero.hbs and you will see line number 6

<h1 class="hero-title">{{t "Welcome to"}} {{@site.title}}</h1>

You can also change search field text from hero.hbs file. Go to line number 15 and change it.

<input type="text" class="form-control w-100 search-input" placeholder="{{t "Search your docs"}}">

Find your Docs

You can change Find your docs section easily. Go to partials/docs.hbs. You will find this type of markup.

<h2 class="section-title">{{t "Find your docs"}}</h2>
<p class="section-text maxw-500 mx-auto">
    {{t "The following articles are the most helpful articles. One of them might be the one you look for your product"}}
</p>

When you will create a new tag and write a post under this, it will show automatically in this section

Faq Section

To change Faq Content go to partials/faq.hbs and go to line number 8

<h2 class="section-title">{{t "FAQ"}}</h2>
<p class="section-text maxw-500 mx-auto">
    {{t "Everything you will find questions that can come in your mind. For more question, contact with us"}}
</p>

To add posts on Faq section, add internal tag #faq in the post, it will show automatically in the Faq section

Contact Section

To change the content of this section, go to partials/contact-promo.hbs

Help Desk Section

To change this section, go to partials/popular-author.hbs. Author will come from Dashboard > Staff

Custom Templates

Custom template is a default setting on Ghost. It can be page template and post template. We have created some custom page and post template for the theme. The page template are as follows:

Page Template

• Membership
• Account
• Signin
• Signup
• Authors
• Contact
• Changelog

Selecting page template

1. Create a new page
2. Click on Settings to the right side and scroll down
3. Select page template i.e. “Membership”

Page url

When you create page, please keep page slug like this.

Page title	Page URl
Membership	/membership/
Account	/account/
Signin	/signin/
Signup	/signup/

For other custom pages, you can add Authors, Tags, Changelog page.

Post Template

• Post Fullwidth Image
• Post Fullwidth

Selecting post template

1. Create a new post or open an old post
2. Go to post settings and scroll down
3. Select template Post Fullwidth Image or Post Fullwidth

Changelog Page

For changelog page, you can add content easily.

1. Create a page
2. Select Custom Template from page setting “changelog”

Add title using Heading 2 tag <h2>. If you add a heading, it will be automatically added on table of contents. Add <pre> tag content to show the code.

- Update : Plugins (Bootstrap, jQuery, PrismJs)
- Update : NPM packages
- Update : Gulp tasks to version 4.x
- Update : Plugins (Bootstrap, jQuery, PrismJs)
- Update : NPM packages
- Update : Gulp tasks to version 4.x

Membership and Subscriptions

This is an awesome features of Ghost. If you want to make money with publications, you can use Membership features of Ghost. To enable members, go to Dashboard > Settings Icon > Membership

Portal Settings

In portal seetings, you can enable Subscribe button at the bottom right of the site.

• Show signup and signin form in popup
• Showing pricing plans
• Changing ancient colors
• Changing icons and text

Stripe connection

Connect your stripe account to get the payment from your subscribers

Subscription Pricing

Add or change your subscription pricing from here

Post Access

When you enable members, you can manage your posts who will see your default posts.

Email Newsletter

You can customize your newsletter template from here; Go to Dashboard > Settings Icon > Email Newsletter

You can also change your support email and email newsletter setting with mailgun using this

Pricing Tables

Here we have used 2 pricing plans.

1. Monthly Plan
2. Yearly Plan

Change the text inside <li>{{t "..."}}</li>

Monthly Plan: For monthly plan {{> members/pricing-tables/pricing-monthly}} partials is used. You will find partials > members > pricing-tables > pricing-monthly.hbs

<ul>
    <li>{{t "Full access to articles"}}</li>
    <li>{{t "Daily updates"}}</li>
    <li>{{t "Support independent publishing"}}</li>
    <li>{{t "Secure Payments"}}</li>
    <li>{{t "No advertisement"}}</li>
</ul>

Yearly Plan: For yearly plan {{> members/pricing-tables/pricing-yearly}} partials is used. You will find partials > members > pricing-tables > pricing-yearly.hbs

<ul>
    <li>{{t "Full access to articles"}}</li>
    <li>{{t "Daily updates"}}</li>
    <li>{{t "Support independent publishing"}}</li>
    <li>{{t "Secure Payments"}}</li>
    <li>{{t "No advertisement"}}</li>
    <li>{{t "One step way to pay"}}</li>
    <li>{{t "Secure Payments"}}</li>
</ul>

Signup for Free

To change the content for this, go to custom-membership.hbs and line number 49.

<div class="sign-content mr-20">
    <h6>{{t "Signup for free"}}</h6>
    <span>{{t "Try our subscriber only articles by signing up for free"}}</span>
</div>
<div class="btn-sign-info">
    <a class="btn subscribe-btn-primary btn-md" href="{{@site.url}}/signup/"> {{t "Sign up"}}</a>
</div>

Account Informations

Account information is shown on Header and Account Page.

Header Information

To change account information on header, go to Partials > members > header-members-information.hbs. If you want to remove from header, just remove this {{> members/header-members-details}} from partials > header.hbs file

Account Page

You can change the account information text on header page also. To change the information, go to partials > members > subscriber-information.hbs

Third Party Plugins

We have created real time search options and Formspree for contact form.

Search Options

We have used Fuze.io for creating real time search. When you will type, you will get instant results. When you install the theme file, you have configure and add content api key on condeinjection

1. Create a custom integrations
2. Copy Content Api Key from your created custom integration
3. Go to Code Injection > Site Header as follows

<script>
    var contentApiKey = "your content api key"
</script>

Contact form

In contact form, we have used Formspree for getting form data. Change your email in <form> tag in custom-contact.hbs file at line number 23.

<form class="row" action="https://formspree.io/youremail@domain.com"  method="POST">

To change contact information, go to custom-contact.hbs file. You change all of the information

Others

This theme supports some custom html styles like Alert

Alert

Alert Primary

<div class="alert alert-primary"> 
    <h4>Well done!</h4> 
    <p>Aww yeah, you successfully read this important alert message. This example text is going to run a bit longer so that you can see how spacing within an alert works with this kind of content.</p> 
    <hr> 
    <p>Whenever you need to, be sure to use margin utilities to keep things nice and tidy.</p> 
</div>

Alert Success

<div class="alert alert-success"> 
    <h4>Well done!</h4> 
    <p>Aww yeah, you successfully read this important alert message. This example text is going to run a bit longer so that you can see how spacing within an alert works with this kind of content.</p> 
    <hr> 
    <p>Whenever you need to, be sure to use margin utilities to keep things nice and tidy.</p> 
</div>

Alert Warning

<div class="alert alert-warning"> 
    <h4>Warning!</h4> 
    <p>Aww yeah, you successfully read this important alert message. This example text is going to run a bit longer so that you can see how spacing within an alert works with this kind of content.</p> 
    <hr> 
    <p>Whenever you need to, be sure to use margin utilities to keep things nice and tidy.</p> 
</div>

Alert Danger

<div class="alert alert-danger"> 
    <h4>Danger!</h4> 
    <p>Aww yeah, you successfully read this important alert message. This example text is going to run a bit longer so that you can see how spacing within an alert works with this kind of content.</p> 
    <hr> 
    <p>Whenever you need to, be sure to use margin utilities to keep things nice and tidy.</p> 
</div>

Buttons

// Primary Button
<a href="#" class="btn btn-primary mt-20">Button</a>

// Left Aligned Button
<a href="#" class="btn btn-primary btn-left mt-20">Button</a>

// Right Aligned Button
<a href="#" class="btn btn-primary btn-right mt-20">Button</a>

// Center Aligned Button
<a href="#" class="btn btn-primary btn-center mt-20">Button</a>

// Outline Button
<a href="#" class="btn btn-outline-primary mt-20">Button</a>

Development and Customization

In this theme, we have used SCSS to develop and style fast. You can easily do it using Prepros. To edit SCSS code, follow the instruction:

1. Unzip docslab.zip (this is the template only file) and remember where is the folder location.
2. Install a SASS compiler, we recommend you to use Prepos 6, you can download it here.
3. Click on “Browse” to add project on the middle side.

Changing Primary and Secondary colors

You can change easily primary, secondary and other colors from _variable.scss file. Open assets/scss/_variables.scss file and change the color that you want, example:

// Primary and Secondary Color
:root {
    --color-primary: #EB2F52;
    --color-heading: #0B1329;
    --color-text: #292A2B;
}

Credits

Fonts and Icon Fonts

• Alata: https://fonts.google.com/specimen/Alata
• Spartan: https://fonts.google.com/specimen/Spartan

• Feather Icons: https://feathericons.com/

Images

• Unsplash: https://unsplash.com/
• Pixels: https://www.pexels.com/

Plugins and libraries

• jQuery: http://jquery.com
• Fitvids: https://github.com/davatron5000/FitVids.js
• Fuse Search: https://github.com/krisk/Fuse
• Prism JS: https://prismjs.com/
• Medium Zoom: https://github.com/francoischalifour/medium-zoom
• Lazy Loading Disqus: https://samclarke.com/lazy-loading-disqus
• Nicescroll: http://nicescroll.areaaperta.com
• Tocbot: https://tscanlin.github.io/tocbot/

Changelog

VERSION – 2.2.0: Release on 26 Oct 2021

* Performace improvements
* Public preview issues fixed
* Cove comment box added
* Small css issues fixed

[+] CHANGED FILES
    package.json
    assets/scss/_variables.scss
    assets/scss/_dark-version.scss
    assets/scss/_post.scss
    assets/scss/style.scss
    partials/footer.hbs
    partials/members/paid-post-box.hbs
    partials/docs-sidebar.hbs
    default.hbs
    index.hbs
    custom-post-fullwidth-image.hbs
    custom-post-fullwidth.hbs
    post.hbs
    assets/js/single.js
    assets/js/scripts.js
    
[+] NEWLY ADDED FILES
    assets/img/shape/shape-1.png
    assets/scss/_cove.scss
    partials/cove-comment.hbs

VERSION – 2.1.0: Release on 14 July 2021

[+] CHANGED FILES
    package.json
    assets/css/tocbot.css
    assets/js/scripts.js
    assets/js/single.js
    assets/scss/_gallery.scss
    assets/scss/_post.scss
    custom-post-fullwidth-image.hbs
    custom-post-fullwidth.hbs
    partials/table-contents.hbs
    post.hbs

* Performace improvements
* Table of contents bug fixed
* Small css issues fixed

VERSION – 2.0.0: Release on 21 March 2021

[+] NEWly ADDED
    assets/img/authors/author.jpg

[+] CHANGED FILES
    package.json
    default.hbs
    assets/css/style.css
    assets/scss/_rtl.scss
    assets/scss/_membership.scss
    assets/scss/_gallery.scss
    assets/scss/_bookmark.scss
    assets/js/scripts.js
    partials/members/free-subscriber-information.hbs
    partials/members/header-members-details.hbs
    partials/members/pricing-tables/pricing-monthly.hbs
    partials/members/pricing-tables/pricing-yearly.hbs
    partials/members/subscriber-information.hbs
    partials/navigation.hbs

VERSION – 1.3.0: Release on 15 March 2021

[+] NEWly ADDED
    custom-post-fullwidth-image.hbs
    custom-post-fullwidth.hbs
    partials/post-head.hbs
    assets/css/tocbot.css
    assets/scss/tocbot.scss

[+] CHANGED FILES
    package.json
    default.hbs
    index.hbs
    author.hbs
    post.hbs
    partials/members/notification-scripts.hbs
    partials/docs.hbs
    partials/footer.hbs
    partials/post-card.hbs
    partials/table-contents.hbs
    assets/css/style.css
    assets/scss/_variables.scss
    assets/scss/_gallery.scss
    assets/scss/_header.scss
    assets/scss/_post.scss
    assets/scss/style.scss
    assets/js/scripts.js
    assets/js/single.js

VERSION – 1.2.0: Release on 08 Oct 2020

[+] NEWly ADDED
    RTL Suported
    _rtl.scss

[+] CHANGED FILES
    SCSS files
    default.hbs

VERSION – 1.1.0: Release on 07 Oct 2020

[+] NEWly ADDED
    Dark Mode
    partials/icons/dark.hbs
    partials/icons/light.hbs
    partials/icons/github.hbs

[+] CHANGED FILES
    SCSS files
    header.hbs
    default.hbs
    package.json
    author.hbs
    contact.hbs
    signup.hbs
    and some other files

VERSION – 1.0.0: Release on 26 Sept 2020

[+] Initial Release