A Jekyll based site for RSJUG site, access it here: http://www.rsjug.org/
-
Responsive layout
-
Mobile 'friendly'
-
Disqus integration
-
Based on github pages
-
Promotes contribution (as it is hosted on github)
-
Automatically build on git push
-
Posts based on Asciidoc (via Asciidoctor and Markdown (focus on content instead of markup)
-
Client side search
-
Fist you will need to install Ruby
ℹ️Use Ruby 2.1
or superior -
Install
Bundler
gem:gem install bundler
💡You can skip this step if you want to install gems individually, see required gems here -
Clone the project:
git clone https://github.com/rsjug/site rsjug-site cd rsjug-site
-
Run
bundle install
ℹ️It will install gems declared in Gemfile
. You can skip this step if gems are already installed❗If you receive the error can’t find header files for ruby at /usr/share/include/ruby.h
you need to install ruby development kit in your operating system://fedora sudo dnf install -y gcc ruby-devel build-essential rubygems libxml2 libxml2-devel libxslt libxslt-devel //ubuntu sudo apt-get install ruby-dev build-essential //or sudo apt-get install ruby2.0-dev //or sudo apt-get install ruby2.2-dev
❗if you get ERROR: Failed to build gem native extension.
, you need to install native extensions://ubuntu sudo apt-get install libgmp-dev libgmp3-dev //fedora sudo dnf install rpm-build
ℹ️output should be: Bundle complete! 7 Gemfile dependencies, 28 gems now installed. Use `bundle show [gemname]` to see where a bundled gem is installed.
-
Then run Jekyll
jekyll serve
-
And finally access http://localhost:4000/site/
💡
|
Every file change is automatically published locally by Jekyll. |
SITE
|
├──_data
│ ├── global.yml (1)
│ ├── nav.yml (2)
├──_includes (3)
│ ├── disqus-comments.html (4)
│ ├── tile.html (5)
│ ├── title-group.html (6)
├──_layout
│ ├── default.html (7)
│ ├── inner.html (8)
│ │
├──_pages (9)
│
├──_posts (10)
│
├──_site (11)
│
├── RakeFile (12)
└── _config.yml (13)
-
Global settings variables
-
Navigation menu bar labels and navigation urls.
-
Page includes of html fragments
-
Disqus integration
-
Layout of posts rendered in initial page (mainly a excerpt of the post with a link to read the full post)
-
Post detail layout
-
Main site layout (/site)
-
Inner pages layout like posts, menus and internal pages
-
Every page (except posts) that have an url, eg:
/sobre
,/busca
etc… -
Site posts
-
Generated site after
jekyll serve
orjekyll build
-
Build and deploy rake task (executed by travisci after git push)
-
Global Jekyll configuration like serving settings, plugins, includes/excludes etc…
Every git push triggers travisci
which will run the deploy
Rake task (see RakeFile) which will deploy the site to github pages.
ℹ️
|
Travis and the rake task is only needed because jekyll-asciidoctor gem is not installed in github pages, see details here.
|
-
Forked this Jekyll with bootstrap theme;
-
Added Asciidoc integration;
-
Played a bit with webfonts;
-
Added
tags
page; -
Added
client side search
using lunr.js; -
Added
archive
to list pages by year/month; -
Played a bit with performance analysis sites like google-speed-test, webpagetest.org and pingdom.