https://github.com/xmonad/xmonad-web

The xmonad.org website
https://github.com/xmonad/xmonad-web

hacktoberfest jekyll window-manager x11 x11-wm xmonad

Last synced: 3 months ago
JSON representation

The xmonad.org website

• Host: GitHub
• URL: https://github.com/xmonad/xmonad-web
• Owner: xmonad
• License: other
• Created: 2012-02-12T05:19:21.000Z (almost 13 years ago)
• Default Branch: gh-pages
• Last Pushed: 2024-03-24T03:10:46.000Z (10 months ago)
• Last Synced: 2024-04-14T05:37:33.810Z (10 months ago)
• Topics: hacktoberfest, jekyll, window-manager, x11, x11-wm, xmonad
• Language: HTML
• Homepage: https://xmonad.org
• Size: 28.8 MB
• Stars: 17
• Watchers: 13
• Forks: 18
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# xmonad-web: the website for the xmonad window manager

The website for [xmonad.org](https://xmonad.org).

## Requirements

The website is built with [Jekyll](https://jekyllrb.com/). Check their website

to get started.

The tl;dr is the following:

1. Install `ruby`, `ruby-dev(el)` and `bundler` on your system. Depending on

   your distribution, `bundler` might not be packaged and may need to be

   installed manually via `gem`:

   ```console

   $ gem install --user bundler

   ```

   Make sure to add the necessary directories to your `$PATH`!

2. Build the website with

   ```console

   $ make

   ```

   This uses `bundler` to get all the necessary Jekyll extensions to

   replicate a GitHub Pages setup locally. The result will be in `./_site`.

3. For an interactive editing session with live reloads in your browser, use

   ```console

   $ 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](https://github.com/xmonad/xmonad/blob/master/CONTRIBUTING.md#rebasing-and-squashing-commits)

for information on rebasing and squashing commits.