xmonad / xmonad-web

The xmonad.org website

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:

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:

   $ gem install --user bundler

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

2. 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.

3. 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.

xmonad-web's Issues

Xmonad for Void Linux

Hi could you add Xmonad void linux install pls?

The links to the source on the documentation pages seem to be broken

For example, go to:

http://xmonad.org/xmonad-docs/xmonad/XMonad-Core.html

and click on any of the "source" links.

Expected behaviour:
One is sent to the line of the source where the given item was defined.

Actual behaviour:
Sent to a github-pages "file not found" page.

Looking at the source, the src sub-directories are missing in xmonad and xmonad-contrib etc.

PS Thank you for maintaining the (otherwise) amazing documentation for an amazing window manager! :)

Update the website

This isn't an issue per se, but I changed a lot to the point a PR doesn't make sense (many conflicts, since I took #5 as my starting point).

Where are the changes?

The source is at https://github.com/TheMC47/xmonad-web/tree/master (so it can be easily deployed to GitHub pages). A preview is available at https://themc47.github.io/xmonad-web/index.html

What is changed

• Cosmetics. I went with the style by https://github.com/tsier (in #5) and cleaned it up a bit
• Hakyll, instead of plain HTML. I think it's more convenient, and we'd only need to edit markdown pages this way
• I didn't change the content almost at all. I'm just trying to get the ball rolling. However, I removed some things (either I didn't reach them through browsing the website, all they're old/outdated like press.html)

What next?

• I think we should include the tutorial from @slotThe in the Getting Started link or as the step-by-step guide here https://themc47.github.io/xmonad-web/documentation.html
• The links to the wiki are kept as they are. We could relatively easily import the wiki to the website since it's just markdown.
• The content needs to be reviewed and updated. I hope this is easier to do because of markdown. However, I think we should do this after deploying the cosmetic changes. That way we have our pipeline setup.
• If we go through with this, I think we should rename the old gh-pages branch and move my master branch to gh-pages

I'm waiting for your feedback!

Notes

• Hiding the menu in the header is broken (clicking the button doesn't bring back the menu)

Update step-by-step configuration to make avoidStruts work properly

The Config should look like this:

...
main = do 
           ...
           xmonad $ docks defaultConfig
           ....

Otherwise xmobar hides behind windows

• hope this get's fixed soon, ctsk

xmbindings cheat sheet font missing

I noticed when doing some work on the xmbindings cheat sheet recently, that the font referenced in the svg (which also appeared in the original png) was missing from my system.

There are actually a few fonts referenced in the svg, but the main typewriter style font which was missing is TlwgTypewriter.
It seems like the full list of fonts from the svg are..
DejaVu Sans, DejaVu Sans Mono, Bitstream Vera Sans Mono, TlwgTypewriter, and Monospace.

I downloaded a copy of TlwgTypewriter to do my edits, but thought it would be better to either link to the correct font, which seems like it is currently maintained on GitHub, https://github.com/tlwg/fonts-tlwg, with the current release at https://github.com/tlwg/fonts-tlwg/releases/tag/v0.7.2

I wanted to just mention it here to at least start a discussion about it. I am not really sure what the preferred fix would be, but thought it was worth bringing up at least.

Thanks for your time!

site xmonad.org did not open

in latest Firefox (124) freezing on connecting to cdn.jsdelivr.net.

Gobo & Fedora download links do not work

The links are dead and should be fixed

`make serve` fails on ruby 3.0

This is not an issue with this repo per se, but it is perhaps valuable to write it down somewhere so people can find this information.

With ruby 3.0, make serve fails with something like

TypeError: no implicit conversion of Hash into Integer

This seems to be caused by pathutil ignoring a deprecation which is now actually a compilation error.

Further, webrick seems to not be bundle anymore, which means it has to be added to the Gemfile.

How to fix it locally

1. Manually apply the patch from envygeeks/pathutil#5 to the pathutil dir:

   $ pwd
   /home/slot/repos/xmonad/xmonad-web/.bundle/xmonad-gems/ruby/3.0.0/gems/pathutil-0.16.2
   $ patch -p1 < diff.patch

   there might be some warnings about missing tests, but this can safely be ignored.

2. As pointed out in jekyll/jekyll#8523, add

   gem "webrick", "~> 1.7"

   to the gemfile or install webrick directly with bundle add webrick.

3. make serve should now work.

Linux Distro Missing [void]

found in the repo for musl and glibc for amd64

--> https://voidlinux.org/packages/?arch=x86_64&q=xmonad

Beautify Xmonad Official Website

Is there any plan to beautify Xmonad official website? I do love to help in this part. What is your opinion, @pjones?

The Xmonad complete documentation will be looks nice as well.

Creates a Special Branch for Hakyll Application

Currently, I'm trying to restructuring the xmonad-web in this repository. I'm created a new branch for the Hakyll application separately form the gh-pages branch. So, contributor will contributing on the Hakyll branch instead of the gh-pages directly. Contributor will send the PR to the Hakyll branch. Then, we may deploy the commits with xmonad-web deploy command. Here is the deployCommand:

cp -r app/html/ ../xmonad-html/ && git checkout gh-pages && cp -rf ../xmonad-html/* . && rm -r ../xmonad-html/ && git status

Yes, the deploy command will bring us to the gh-pages branch and replace all the changes. So, the gh-pages will contain the web contents only. Any advice?