HAM is a Jekyll-based boilerplate template for generating better, static wiki-style websites. HAM can be instantly used to build static wiki pages. But the best of all, the default theme of HAM can be easily customized to create more personalized wiki pages, unlike those from MediaWiki, for example.
This project is built to replace the current, MediaWiki installation at
What does HAM stand for?
HAM is short for:
- Hackapedia’s Abstraction Machine
- HAM Ain’t MediaWiki
- Halfmoon and Markdown
- && i++ (can we get more pull requests to add more stuff into this list?)
What HAM is
- A static-site wiki generator
- A better alternative than GitHub pages
- Highly customizable through Halfmoon and Jekyll
- Uses GitHub-Flavored Markdown (GFM)
- Optimized for GitHub Pages and Gitlab Pages
What HAM isn’t
- Optimized for large wiki content (this is where advanced alternatives such as MediaWiki excels at)
- Built-in support for hosting content written in MediaWiki markup syntax (however there are converters to Markdown)
- Supported in legacy web browsers (see Compatibility)
What HAM would be
- Supporting Forem (DEV.to) liquid tags (YouTube embeds, Twitter posts, etc.)
For GitHub Pages
If you would like to add this theme into your GitHub Pages website, please just add the following on your
The best part of this is that you can get the latest version of HAM without manually requiring it on your Gemfile, as long as you have updated your page frequently (GitHub will fetch the current available version of the HAM “theme”).
As a Gem-based theme
If you have just created a new site with
jekyll new <PATH> chances are that you’re using the default, Minima theme instead of HAM. If that’s the case, replace the line which begins with
gem "jekyll-ham", "~> 0.1.2"
Also don’t forget to change the
theme configuration on your
jekyll-ham instead of
Site does not load properly after first
In previous versions of HAM (0.1.5 and earlier), all of your Markdown and HTML files must include the following frontmatter:
--- layout: page ---
However, as of 0.1.6
jekyll-optional-front-matter has been included and configured by default to remove this requirement, which allows easier content migration for future wikis.
HAM also introduces additional configuration which you can set on your
ham: site_icon: https://raw.githubusercontent.com/googlefonts/noto-emoji/main/svg/emoji_u1f969.svg # Your site icon, to be displayed on navbar site_favicon: null # Your site favicon, in case you have a spare favicon.ico for it contributing: # Additional metadata for "Contribute to This Page" section on sidebar discuss: # For "Discuss" (or "Talk page" on MediaWiki) type: url # Currently supports "url". Support for other discussion widgets such as DiscussBot (Telegram), Disqus, and Utteranc.es are coming soon. url: https://github.com/reinhart1010/HAM/discussions/ view_source_base_url: https://github.com/reinhart1010/HAM/blob/main/ # The base URL to publicly view the original (Markdown) source code issue_url: https://github.com/reinhart1010/HAM/issues/ # The URL to report an issue related to site or content
Credits & Open Source Licenses
Copyright (c) 2021 Reinhart Previano Koentjoro.
This project is distributed under MIT License, and also uses the following open-source components:
- Bootstrap Icons (https://github.com/twbs/icons) - Copyright (c) 2019-2021 The Bootstrap Authors, MIT License
- Halfmoon (https://github.com/halfmoonui/halfmoon) - Copyright (c) 2020 Halfmoon UI, MIT License
- OneDarkJekyll (https://github.com/mgyongyosi/OneDarkJekyll) - Copyright (c) 2016 Mihály Gyöngyösi, MIT License
- Simple-Jekyll-Search (https://github.com/christian-fei/Simple-Jekyll-Search) - Copyright (c) 2015 Christian Fei, MIT License