Awesome
xmonad-web: the website for the xmonad window manager
The website for xmonad.org.
Requirements
The website is built with Jekyll. Check their website to get started.
The tl;dr is the following:
-
Install
ruby
,ruby-dev(el)
andbundler
on your system. Depending on your distribution,bundler
might not be packaged and may need to be installed manually viagem
:$ gem install --user bundler
Make sure to add the necessary directories to your
$PATH
! -
Build the website with
$ make
This uses
bundler
to get all the necessary Jekyll extensions to replicate a GitHub Pages setup locally. The result will be in./_site
. -
For an interactive editing session with live reloads in your browser, use
$ make serve
This serves a browsable local copy of the website—and your changes thereof—on
http://127.0.0.1:4000
.
Application Structures
All the .md
files in the root (except for README.md
) will
be converted into html
files. These go at the root of the
website. The css
directory has custom styles.
Images should go in the images
directory.
The videos that are linked in videos.html
are hardcoded in
the _data/videos.yml
The _site
directory is a place for the Jekyll output.
Contributing
Contributions to the content as well as to the looks of the website are welcome!
Please don't check the _site
folder, as it will be overwritten while
deploying the website. Check our contributing
guidelines
for information on rebasing and squashing commits.