Jekyll in-toto website
In-toto's project website is created with Jekyll and extends the GitHub pages slate theme.
The site is available at https://in-toto.io
Maintenance and re-use
Basic commands
GitHub pages are served directly from the repository. No pre-building necessary.
For development deployment I recommend the following commands (requires
jekyll
to be installed and available on your path):
# Automatic verbose re-build whenever sources change
jekyll build --watch --verbose
# Development server available on http://127.0.0.1:4000
jekyll serve
Changing the header
Set the variables title
, description
and logo_url
in
_config.yml
to customize the header. These variables are used
in _layouts/default.html
to populate the header.
Changing the menu
The menu is populated from the YAML file in
_data/navbar.yml
. It should be enough to just customize
this file. The menu has two levels. On the first level you can specify a text
and either a url
or a sub
(not both). If url
is specified the menu item
will link to that url. If sub
items are specified, hovering over a menu item
will open a dropdown menu, showing the sub items.
Sub items also have a text
and a url
that can be used analogously.
Additionally, subitems have a boolean external
variable that, if set to
true
, adds a little external link icon next to the link text.
The menu is styled in _sass/navbar.scss
and its markup
can be found in _includes/navbar.html
, which is
included in the default layout.
Changing the footer
Just customize _includes/footer.html
.
General styles and layouts
Base styles are inherited from
_sass/jekyll-theme-slate.scss
and
_sass/rouge-github.scss
. You should not modify
those styles, but rather override them in your own _sass/*.scss
or
in _sass/main.scss
, where currently all custom styles
are defined. All styles are included in
assets/css/style.scss
, which gets compiled to css on
jekyll build
. The resulting assets/css/style.css
is included in the default
layout.
Customizing and adding content
Adding content is as simple as creating *.html
, or *.md
files and filling
them with content. Each file in the project directory gets copied to the build
directory, i.e. _site
on jekyll build
and is accessible via the same
relative path on the server.
Additionally, you should specify at least two properties in each file's YAML front matter section, to tell jekyll that you want to embed your content in the default layout and to give the container in which your content will be placed a unique CSS id. This is what front matter looks like:
---
layout: default
css_id: my-funky-page
---
Adding assets
Add assets, e.g. images or JavaScript, to assets
.
Replace favicon.ico
favicon.ico
should be served from the root of the project.
Just replace the current one with the favicon.ico
of your project.