Skip to content

Home

Jump to bottom
Maicon Pinto edited this page Nov 20, 2018 · 6 revisions

Home Tips

The first step is to add title attribute on your header of Page Home.

# index.md

---
title: Documentation
---

The next step we can change the branding title. There are two ways how to do this.

On your _config.yml you have two attribute: branding or branding_title.

branding

The attribute branding will be use when you want to customize code fully of your branding section.

For example:

branding: >-
    <h1 class="logo">
        <span aria-hidden="true" class="icon_documents_alt icon"></span>
        <span class="text-highlight">Pretty</span><span class="text-bold">Docs</span>
    </h1>

branding_title

The attribute branding_title will be use when you want to customize only title of branding section.

For example:

branding_title: >-
    <span aria-hidden="true" class="icon_documents_alt icon"></span>
    <span class="text-highlight">Pretty</span><span class="text-bold">Docs</span>

OR, only a simple title:

branding_title: My Personal Project

Below, you find all attributes that you can to change to customize your page Home.

Attributes on _config.yml

home

cards-section

Below, what function to each attribute.

tagline

Tagline is message on below that branding section. Normally, you can use this space to use like a subtitle of the project, ou define what is the project with a little more details.

tagline_subtitle

Following the same case of branding and branding_title, tagline_subtitle is a alternative way to define a subtitle, in this case the suggest is a simple subtitle, not a long text description.

socials

The attribute socials is important because, is it define if has or not the social section. By default, if you don't define this attribute, it will show the content of PrettyDocs template.

You can disable it, set to false the value. But if you to define to true the value, you can to define more details, like github_repository, twitter_share and facebook_share.

social_github

This attribute will help you to disable share on github when you set false value. By default it is enable.

github_repository

This attribute is used to show Star button of github. You just define repository name, like jekyll-theme-prettydocs. This will linked with the github_username, that already exists by default.

github_username

This attribute already exists by default. You just will need to change it.

social_twitter

This attribute will help you to disable share on twitter when you set false value. By default it is enable.

twitter_share

The twitter_share is a message that will be share on twitter. When you click twitter button, will open a box with a message, it is this content that will opened on share box.

twitter_username

This attribute already exists by default. You just will need to change it.

social_facebook

This attribute will help you to disable share on facebok when you set false value. By default it is enable.

facebook_like

The facebook_like is a url that you use in like button of facebook.

cards_title

The cards_title is the title on cards section. The default text is 'Getting started is easy!'.

description

This attribute already exists by default. You just will need to change it.

download_button

This attribute will help you to disable download button when you set false value. By default it is enable.

download_url

The download_url is link to download your project. Normally, you point to repository.

card_start

This attribute will help you to disable card start when you set false value. By default it is enable.

card_start_title

The 'Quick start' is the default value. But you can change it.

card_start_intro

Normally, you have a 'Lorem ipsum' text by default. But you can change it.

card_start_link

The '/start' is the default value. But you can change it.

card_components

This attribute will help you to disable card components when you set false value. By default it is enable.

card_components_title

The 'Components' is the default value. But you can change it.

card_components_intro

Normally, you have a 'Lorem ipsum' text by default. But you can change it.

card_components_link

The '/components' is the default value. But you can change it.

card_charts

This attribute will help you to disable card charts when you set false value. By default it is enable.

card_charts_title

The 'Charts' is the default value. But you can change it.

card_charts_intro

Normally, you have a 'Lorem ipsum' text by default. But you can change it.

card_charts_link

The '/charts' is the default value. But you can change it.

card_faqs

This attribute will help you to disable card faqs when you set false value. By default it is enable.

card_faqs_title

The 'FAQs' is the default value. But you can change it.

card_faqs_intro

Normally, you have a 'Lorem ipsum' text by default. But you can change it.

card_faqs_link

The '/faqs' is the default value. But you can change it.

card_showcase

This attribute will help you to disable card showcase when you set false value. By default it is enable.

card_showcase_title

The 'Showcase' is the default value. But you can change it.

card_showcase_intro

Normally, you have a 'Lorem ipsum' text by default. But you can change it.

card_showcase_link

The '/showcase' is the default value. But you can change it.

card_license

This attribute will help you to disable card license when you set false value. By default it is enable.

card_license_title

The 'License' is the default value. But you can change it.

card_license_intro

Normally, you have a 'Lorem ipsum' text by default. But you can change it.

card_license_link

The '/license' is the default value. But you can change it.

I want full control about code generated

However, if you want more control about code, and to you do not need change so many attributes on _config.yml, you will need to create _includes/home.html file and put your code there. This way you have full control about code generated, but in this case, you need more HTML skills.

Clone this wiki locally