Jekyll intro

Getting started

GitHub Pages can automatically generate and serve the website for you. Let’s say you have a username/organisation my-org and project my-proj; if you locate Jekyll source under docs folder of master branch in your repo github.com/my-org/my-proj, the website will be served on my-org.github.io/my-proj. The good thing about coupling your documentation with the source repo is, whenever you merge features with regarding content to master branch, it will also be published in the webpage instantly.

  1. Just download the source from github.com/aksakalli/jekyll-doc-theme into your repo under docs folder.
  2. Edit site settings in _config.yml file according to your project.
  3. Replace favicon.ico and img/logonav.png with your own logo.

Writing content

Docs

Docs are collections of pages stored under _docs folder. To create a new page:

1. Create a new Markdown as _docs/my-page.md and write front matter & content such as:

---
title: My Page
permalink: /docs/my-page/
---

Hello World!

2. Add the pagename to _data/docs.yml file in order to list in docs navigation panel:

- title: My Group Title
  docs:
  - my-page

Blog posts

Add a new Markdown file such as 2017-05-09-my-post.md and write the content similar to other post examples.

Pages

The home page is located under index.html file. You can change the content or design completely different welcome page for your taste. (You can use bootstrap componenets)

In order to add a new page, create a new html or markdown file under root directory and link it in _includes/topnav.html.

This template uses bootstrap-sass along with bootwatch themes. You can create your own theme by writing your own sass files.

Create a new a theme folder like _sass/bootwatch/custom and set your bootwatch variables in _config.yml to custom:

bootwatch: custom


Improve this page