An open API service indexing awesome lists of open source software.

https://github.com/jaandrle/jaandrle.github.io

Personal page/blog
https://github.com/jaandrle/jaandrle.github.io

jekyll-blog

Last synced: over 1 year ago
JSON representation

Personal page/blog

Awesome Lists containing this project

README

          

# Jan Andrle – Personal sites / Blog
This document covers building and managing my pages with [Jekyll](#jekyll). There are two main sections [my blogging info setup](#this-instance) and [general info](#general).

## Current progress/state
- [Technická část](https://github.com/jaandrle/jaandrle.github.io/projects/2?fullscreen=true) for technical background.
- [Správa příspěvků](https://github.com/users/jaandrle/projects/4) for posts progress.

## This instance
The `master` (`main`) branch reflects current public state of web page. There are some helpers/setups for speed up blogging.

### Generic Tags
- aplikace, miniaplikace, webové služby
- úvahy
- návody, pokročilejší návody, vývojářské návody
- tipy, pokročilejší tipy, vývojářské tipy
- seznámení, pokročilejší seznámení, vývojářské seznámení
- Windows, Ubuntu (linux), web
- Internet Explorer, Chrome, Chromium, Firefox, Opera

### Pages/Posts options
The default options are saved in [_config.yml](./_config.yml).

| option | available | default / [R]equired | description |
|:-----------------:|:---------:|:--------------------------:|:----------------------------------------------------------------------------------------------------------------------------------------------------------:|
| layout | all | default | See [_layouts](./_layouts) |
| -\|\|- | posts | post | -\|\|- |
| in_menu | pages | null | The name of item to show in page side menu/list |
| excerpt_separator | posts | `` | |
| permalink | all | [R] | |
| -\|\|- | posts | /blog/:year-:month/:title/ | |
| title | all | [R] | Page/Post name |
| category | all | "" | See [blog](./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](./_includes/show_toc.html) |
| reference | posts | | See [_includes/references_list.html](./_includes/references_list.html) |
| redirect_from | all | | See [jekyll/jekyll-redirect-from: Seamlessly specify multiple redirections URLs for your pages and posts.](https://github.com/jekyll/jekyll-redirect-from) |
| noindex | all | null | See [robots.txt](./robots.txt) and [sitemap.xml](./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](./_inclused/i/molecule_scriptsBody.html) |

### Helpers
My partials/data for simplify creating posts.

#### Include
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='![alt](src)'`.
- `href`, `src` for links/images/…
- `title`, `alt` for links/images/…
- `caption` for description (eg. ``)
- `file`s
- [`{% include code.html …`](./_includes/code.html)
- [`{% include image.html …`](./_includes/image.html)
- [`{% include textBox.html …`](./_includes/textBox.html)
- [`{% include reference.html …`](./_includes/reference.html)
- [`{% include references_list.html …`](./_includes/references_list.html)
- [`{% include kbd.html …`](./_includes/kbd.html)
- [`{% include blockquote.html …`](./_includes/blockquote.html)
- [`{% include q.html …`](./_includes/q.html)
- [`{% include icon.html …`](./_includes/icon.html)
- ([`{% include show_toc.html …`](./_includes/show_toc.html))
- **Important note:** It isn't supported to neste `include` components
- Instead of: `{% include textBox.html text="{% include kbd.html keys='Ctrl A' %}" %}`
- Use workaround: `{% capture tmp_kbd %}{% include kbd.html keys='Ctrl A' %}{% endcapture %}{% include textBox.html text=tmp_kbd %}`

#### Data/Snippets
- [`{{ site.data.abbr.* }}`](./_data/abbr.yml) for using abbreviation
- [``](https://www.maxiorel.cz/jak-zdarma-vlozit-pdf-do-webove-stranky-hned-nekolika-zpusoby "Jak zdarma vložit PDF do webové stránky? Hned několika způsoby | Maxiorel.cz") – see [ | MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/embed ": The Embed External Content element - HTML: HyperText Markup Language | MDN"); it is also possible append to `src` (separated by `#`) combination of `page`, `chapter`, `zoom`, `view`, …

### Automation
See [Schedule to Publish Future Posts](https://github.com/jaandrle/jaandrle.github.io/issues/65).

## General
### Jekyll
**Jekyll** is a static site generator that's perfect for GitHub hosted blogs ([Jekyll Repository](https://github.com/jekyll/jekyll)). The [**Build A Blog With Jekyll And GitHub Pages**](http://www.smashingmagazine.com/2014/08/01/build-blog-jekyll-github-pages/) article can be good accsess point for those interested in using it for their own blog.

### Local Development
1. Prerequisite, see [Installation | Jekyll • Simple, blog-aware, static sites](https://jekyllrb.com/docs/installation/).
1. Install Jekyll and plug-ins in one fell swoop. `gem install github-pages` This mirrors the plug-ins used by GitHub Pages on your local machine including Jekyll, Sass, etc.
1. Clone down your fork `git clone https://github.com/yourusername/yourusername.github.io.git`
1. Serve the site and watch for markup/sass changes `jekyll serve`
1. View your website at http://127.0.0.1:4000/
1. Commit any changes and push everything to the master branch of your GitHub user repository. GitHub Pages will then rebuild and serve your website.