Personal website https://2martens.de
Go to file
Jim Martens 8285c72769 Removed no longer valid link to tweet
Signed-off-by: Jim Martens <github@2martens.de>
2017-12-25 23:16:23 +01:00
_assets Added css class for large font size 2017-12-25 16:34:20 +01:00
_data Made sidebar boxes dynamic 2017-12-25 22:05:42 +01:00
_includes Made sidebar boxes dynamic 2017-12-25 22:05:42 +01:00
_layouts Fragment jumps now respect fixed navbars 2017-12-25 16:04:29 +01:00
_posts Removed no longer valid link to tweet 2017-12-25 23:16:23 +01:00
assets Removed hard-coded brand and author information 2017-12-25 21:53:21 +01:00
blog Added blog category 2017-12-25 15:08:34 +01:00
cs Made publications dynamic 2017-12-25 21:58:27 +01:00
pages Added grade to bachelor 2017-12-25 19:11:46 +01:00
politics Added G20 sub category page 2017-12-25 13:16:08 +01:00
scripts Added step to deploy script that removes temporary directory 2017-12-25 21:21:57 +01:00
speeches Created category for speeches 2017-12-25 13:42:30 +01:00
.gitignore Modified gitignore 2016-04-15 14:48:25 +02:00
.travis.yml Added IPv4 address of Uberspace to known SSH hosts 2017-12-25 21:18:20 +01:00
CNAME Added CNAME entry 2016-04-15 14:45:00 +02:00
Gemfile Added travis CI 2017-12-25 20:24:33 +01:00
Gemfile.lock Added travis CI 2017-12-25 20:24:33 +01:00
LICENSE Added missing space that should make GitHub pick up Apache 2.0 license 2017-12-25 22:39:47 +01:00
README.md Added missing host info 2017-12-25 22:18:56 +01:00
_config.yml Added README 2017-12-25 21:52:09 +01:00
deploy_ed25519.enc Added travis CI 2017-12-25 20:24:33 +01:00
feed.xml Switched to jekyll assets 2017-12-24 20:10:30 +01:00
google98936b4605d7df21.html [Global] Added google site verification 2016-10-03 13:26:19 +02:00
index.html Made display of blog posts heading conditional on available posts 2017-12-25 16:15:42 +01:00

README.md

Personal Website

Build Status

This repository hosts my personal website. It is jekyll powered with all required dependencies described in the Gemfile. If you wanted, you could create the very same website with this repository that you can find under the official URL.

You can use it as a starting point for your own website. In the following I will describe what you need to change to make it your own (minimal changes).

Customization

  • _config.yml: this contains the site configuration, update it to meet your needs
  • _data/: this directory contains data files that allow for easy website changes
  • _data/author.yml: this file describes the key values for the author (website owner), the values are also used to populate the CV page and the author sidebar box
  • _data/footer-menu.yml: defines the footer menu
  • _data/header-menu.yml: defines the header menu
  • _data/notification.yml: defines the global configuration and if it is visible
  • _data/promotion.yml: defines the promotion and if it is visible
  • assets/: required static files
  • assets/images/uberspace-badge-*.png: must be changed to accomodate your promotional image
  • assets/images/brand.svg: must be changed to your brand image
  • assets/pdf/cv.pdf: change for your CV in PDF format
  • _posts/: delete and write your own posts
  • _includes/: no need to touch, nothing hard-coded inside
  • _includes/sidebar/: contains available sidebar boxes, add files here and then you can already use the new sidebar box
  • pages/: directory for pages, don't forget permalink variable for new pages, update every page but 404.html and cv.html to your situation
  • index.html: you should probably update the text here

Beyond this no changes are absolutely necessary. No links are hard-coded in the pages, layouts or include files beyond the technical dependencies.

The sidebar is configured via variables in the YAML front matter. By default the author sidebar box is shown everywhere. You can customize this by adding the variable sidebarboxes to the front matter of a post, page or category. Then specify all boxes you want to use by their file name without the extension in the order they should appear separated by a whitespace each. Look into existing pages for examples.

Without any new files other than posts, these categories are supported out of the box:

  • speeches (appears under Speeches menu point)
  • politics (appear under Politics menu point)
  • politics G20 (appears both under Politics and Politics/G20 menu points)
  • cs (appears under Computer Science menu point)
  • blog (appears under Blog menu point)
  • site (appears on home page)

Continuous Integration and Deployment

The .travis.yml file is already in a good state to use it for own needs. But you need to update it to make it work for you. In the following I will list the absolute minimal changes you need to do.

  • scripts/deploy.sh: change martens7 to your Uberspace user and wolf.uberspace.de to your host
  • .travis.yml: update the known hosts for your Uberspace host, update the before_deploy section (first dash)
  • deploy_ed25519.enc: change to your encrypted SSH key

To understand how to prepare the SSH connection, follow this link: https://oncletom.io/2016/travis-ssh-deploy/