This document covers building and managing my pages with Jekyll. There are two main sections my blogging info setup and general info.
The master (main) branch reflects current public state of web page. There are some helpers/setups for speed up blogging.
The default options are saved in _config.yml.
| option | available | default / [R]equired | description |
|---|---|---|---|
| layout | all | default | See _layouts |
| -||- | posts | post | -||- |
| in_menu | pages | null | The name of item to show in page side menu/list |
| excerpt_separator | posts | <!--more--> |
|
| permalink | all | [R] | |
| -||- | posts | /blog/:year-:month/:title/ | |
| title | all | [R] | Page/Post name |
| category | all | "" | See blog – mainly (non)dev; Empty by default → listed in both categories |
| tags | posts | List of tags, eg. [tag_1] |
|
| show_toc | all | 0 | Headline level deep to generating TOC, see _includes/show_toc.html |
| reference | posts | See _includes/references_list.html | |
| redirect_from | all | See jekyll/jekyll-redirect-from: Seamlessly specify multiple redirections URLs for your pages and posts. | |
| noindex | all | null | See robots.txt and sitemap.xml |
| date | all | based on filename | In form YYYY-MM-DD HH:MM:SS |
| updated | posts | In form YYYY-MM-DD |
|
| MathJax | all | null | Use MathJax for processing page including mathematics, see _inclused/i/molecule_scriptsBody.html |
My partials/data for simplify creating posts.
In general {% include file ...options %} with standarized options
code, img and similar tags supproted by Markdown (the idea is to extend these, but still at least particually be able see that in .md). So, example: {% include image.html img=''.href, src for links/images/…title, alt for links/images/…caption for description (eg. <figcaption>)files
include components
{% include textBox.html text="{% include kbd.html keys='Ctrl A' %}" %}{% capture tmp_kbd %}{% include kbd.html keys='Ctrl A' %}{% endcapture %}{% include textBox.html text=tmp_kbd %}{{ site.data.abbr.* }} for using abbreviation<embed src="https://github.com/jaandrle/jaandrle.github.io/raw/master/soubor.pdf" type="application/pdf" width="100%" height="500px" /> – see ; it is also possible append to src (separated by #) combination of page, chapter, zoom, view, …See Schedule to Publish Future Posts.
Jekyll is a static site generator that's perfect for GitHub hosted blogs (Jekyll Repository). The Build A Blog With Jekyll And GitHub Pages article can be good accsess point for those interested in using it for their own blog.
gem install github-pages This mirrors the plug-ins used by GitHub Pages on your local machine including Jekyll, Sass, etc.git clone https://github.com/yourusername/yourusername.github.io.gitjekyll serve