Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Cleanups, fixes, Makefile, … #29

Merged
merged 15 commits into from
Jun 4, 2021
Merged

Cleanups, fixes, Makefile, … #29

merged 15 commits into from
Jun 4, 2021

Conversation

liskin
Copy link
Member

@liskin liskin commented Jun 4, 2021

Clean up Gemfile and _config.yml

Drop plugins that are included in github-pages by default, drop stuff
that isn't needed/used (minima, Windows-specific gems), drop baseurl.

The thinning of Gemfile may actually be necessary, as bundler's
dependency resolution sometimes installs a horribly old version of
github-pages when it starts the resolution with jekyll-default-layout,
as github-pages depends on an older version of jekyll-default-layout,
and its resolution algorithm then goes all crazy.

Add Makefile to install github-pages and build/serve the site

Exclude dev plumbing from _site

Drop unused css/default.css

Speed up Jekyll build

We're not using any Jekyll themes and this cuts the build time from 1.5
seconds to a little over 100 milliseconds.

Fix Raleway font not being used

Fix broken links to non-existent intro.html

What used to be intro.html is now install-instructions.md.

install-instructions: Refresh the list of required libraries

tour: Fix unclosed `

Workaround for livereload @import bug

Gets rid of the annoying

[2021-06-04 10:27:26] ERROR `/font-raleway.css' not found.

because livereload incorrectly handles relative @import in CSS.

Related: lepture/python-livereload#248

Relative links to images

site.url is hardcoded to https://xmonad.org, even when serving locally
or from a fork at GitHub.

Add GitHub Actions workflow to check links (both internal and external)

"Stolen" from https://github.com/liskin/work.lisk.in/blob/c6ad22896ad933aed93cc752e0373d4bdb3bc3a8/.github/workflows/linkchecker.yaml

Fix/add links to former xmonad developers

Fix broken links to dzen and rxvt-unicode

liskin added 14 commits June 3, 2021 11:33
Drop plugins that are included in github-pages by default, drop stuff
that isn't needed/used (minima, Windows-specific gems), drop baseurl.

The thinning of Gemfile may actually be necessary, as bundler's
dependency resolution sometimes installs a horribly old version of
github-pages when it starts the resolution with jekyll-default-layout,
as github-pages depends on an older version of jekyll-default-layout,
and its resolution algorithm then goes all crazy.
We're not using any Jekyll themes and this cuts the build time from 1.5
seconds to a little over 100 milliseconds.
What used to be intro.html is now install-instructions.md.
Gets rid of the annoying

    [2021-06-04 10:27:26] ERROR `/font-raleway.css' not found.

because livereload incorrectly handles relative @import in CSS.

Related: lepture/python-livereload#248
site.url is hardcoded to https://xmonad.org, even when serving locally
or from a fork at GitHub.
@liskin
Copy link
Member Author

liskin commented Jun 4, 2021

GitHub says the branch hasn't been deployed but it has, here: https://liskin.github.io/xmonad-web/tour.html

Copy link
Member

@slotThe slotThe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like this!

Can confirm steps in the README work for me when building with the new Makefile

download.md Outdated
@@ -71,6 +71,6 @@ cabal install https://github.com/xmonad/xmonad-contrib/archive/master.tar.gz
Here are some tools we've found work well with xmonad:

* [dmenu](https://tools.suckless.org/dmenu/), a program launcher
* [dzen](https://gotmor.googlepages.com/dzen), an extensible status bar
* [dzen](https://robm.github.io/dzen/), an extensible status bar
* [xmobar](https://hackage.haskell.org/package/xmobar), an extensible status bar
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder of hackage is the right place to link to concerning xmobar. This should probably go to either GitHub or xmobar.org

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

xmobar.org seems to be from before https://github.com/jaor/xmobar/commit/fa8c748b5b2e3a1a6f6add0ad6bc2a8e56ddcc28, which seems to also be the point when Hackage stopped rendering xmobar's readme, so yeah, linking to GitHub is now the best option.

Copy link
Member

@TheMC47 TheMC47 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for this much-needed cleanup! At least some of us have a clue on what they're doing 😀

Since https://github.com/jaor/xmobar/commit/fa8c748b5b2e3a1a6f6add0ad6bc2a8e56ddcc28,
Hackage no longer renders the readme, and https://xmobar.org/ also
doesn't seem to be updated since then.
@liskin liskin merged commit c11e866 into xmonad:gh-pages Jun 4, 2021
@github-pages github-pages bot temporarily deployed to github-pages June 4, 2021 13:01 Inactive
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants