Blogue de la géomatique du MSP

Documentation - Configuration & First Steps

Auteur :

Configuration

All configuration options are in the _config.yml file.

Created by Patricia Mafra
General Settings
  • name: Your name.
  • job_title: Your job title.
  • email: Your email. There are two cases where email is used. First, if you entered the email and you’ve activated show_email option the end result will be a visible social email icon in the sidebar. The second use of your email is when you do not set your own avatar. In this case your email is used by the gravatar plugin to automatically fetch your gravatar.
  • description: Describe yourself with a couple of words.
  • avatar: Write down the full path to the avatar http://mysite.com/blog/assets/images/avatar.jpg. If you comment this row, “Steve” checks if you have an email and shows your gravatar if you have any.
  • favicon: Want a favicon? Enter the full path here. For example http://mysite.com/blog/assets/favicon.ico.
  • twitter_handler: Add your Twitter username without the @. It will be used for Twitter Cards. The default card type for “Steve” is Summary Card with Large Image.
  • analytics_code: Add your Google Analytics Tracking ID. Example ID: UA-XXXXXXX-2.
  • disqus: Add your website shortname from Disqus.

Important Note: Keep in mind that name, job_title, twitter_handler and some of the post specific variables are used as default meta data in some cases.

Social Accounts
  • social_networks: Here you can find the list of all the available social networks that you can currently use. Of course you can always add a new one by yourself or ask for it to be available in the next version of the theme. If you don’t want a specific social network to be seen, just leave the url value empty or delete the line.

Important: Do not change the names of the social networks!

Modules Settings

One thing to remember - 1 is on, 0 is off.

  • show_categories: If it is on and you’ve added categories in the post itself the categories will be visible. If it is off and you’ve added categories in the post they will be hidden. This option is helpful if you want to turn on/off categories for all your posts at once.
  • show_tags: If it is on and you’ve added tags in the post itself the tags will be visible. If it is off and you’ve added tags in the post they will be hidden. This option is helpful if you want to turn on/off tags for all your posts at once.
  • show_email: If this is turned on and you’ve entered an email value in email, an email icon will appear next to your social media accounts and all your readers will be able to contact you.
  • show_rss: If this is turned on, a new RSS button will appear in the sidebar next to your social media accounts.
  • show_comments: If it is on and you’ve added comments: true in the post itself the comments will be visible. If it is off and you’ve added comments: true in the post the comments will be hidden. This option is helpful if you want to turn on/off comments for all your posts at once.
  • show_menu: If it is on the main menu will be visible.
  • fixed_sidebar: If it is on the sidebar will be fixed (sticky).
Defaults
  • defaults: The only available option at the moment is whether to enable the comments automatically in the post or not. The default value is true.
Serving

These options are pretty important, so take a closer look. If you experience any problems with your paths you should check them here.

  • url: Enter your domain! Example: https://mysite.com
  • baseurl: The baseurl can remain empty if you’re not going to host your site in a subfolder. But if you want your site to be something like htttp://mysite.com/blog you should write down /blog here.
Includes
  • include: Force the inclusion of the pages directory.
Outputting
  • permalink: By default your links will look like this http://mysite.com/categories/post-name.html. If you want a different permalink check Jekyll documentation.
  • category_dir: The default directory is categories, so for example if you go to random category index you will see something like this http://mysite.com/categories/category-name/postname.html.
Pagination
  • paginate: You should enter a number that stands for the number of posts per page.
  • paginate_path: The default path is /page:num/, so for example if you go to second page you will see something like this http://mysite.com/page2/.

Important Note: Pagination is currently working only on home page due to Jekyll limitations.

Conversion
  • markdown: Choose your Markdown renderer. Different Markdown renderers supported by Jekyll sometimes have extra options available. I suggest to stick with the default.
  • excerpt_separator: By default when you’re writing a post, you should add <!--more--> to define excerpt. You have three options - to leave it as is, to change the tag or to completely remove it but in this case you’ll always see the full content.
Assets Settings
  • sass: Choose the path to all of yours SCSS partials and the compression method for the final file.

If you need extra help, just check out the official Jekyll documentation.

Additional Configuration

How to change your default theme color?
Just go to /assets/partials/_vars.scss and change the color of the $primary-color variable.
How Facebook knows which image to use for sharing?
By default the script gets the first image in the post so take that in mind when you write a blog post.

Adding Post

The next thing after you are done with the configuration file is to add your first post. You will need to have at least basic knowledge of HTML or Markdown.

All you need to do is to create a new file with name YYYY-MM-DD-my-first-post and .markdown or .md extension. Create it in the _posts folder. By default the name of the file is composed by date and title but you can overwrite these in the post’s front matter.

In the beginning of the every post you have a so called front matter block which contains some data about the post. Here is the short description of the options.

layout: The post layout.

date: Exact date when the post is published. The date is actually pretty important and I suggest you never change it. Specific date helps Jekyll to order correctly all the posts. Also, the date is used to generate a unique ID, so Disqus can always get the right comments for the right post, even when you change the title.

title: Post’s title.

description: Meta description used for better SEO.

comments: By default they are always true, but if you want to turn them off for a specific post just set this to false.

category: List the categories in which you want your post to appear.

tags: List your tags here.

Adding Page

Adding page is even simpler than adding post. Just create a sub-folder to the pages directory and inside that sub-folder create index.md file. The folder name is your page name. Every folder must contain index file. Pages are also using front matter to add information to your page.

layout: The page layout.

title: Page’s title.

permalink: This is important. If you do not enter the permalink, your url will be something like this http://example.com/_pages/about. Enter the permalink and get rid of /_pages/ part. Do not forget the trailing slash!

That’s it! Do not hesitate to ask if you have any questions. Also you can send me feature requests. There are some nice features that are planed for the upcoming versions. Happy blogging!