mold π
A minimal optimized lightweight design for Github Pages.
Inspired from no-style-please and the-monospace-web.
βSimplicity is the ultimate sophistication.β
β Leonardo da Vinci
Features β¨
- π A WYWIWYS theme (What You Write Is What You See)
- β‘οΈ Fast
- π Light and dark theme
- π± Responsive
- π Content-first (typography optimized for maximum readability)
- π SEO optimized (uses Jekyll SEO Tag)
- π° RSS feed (uses Jekyll Feed)
- β Mathjax support
- π§ββοΈ Mermaid support
Usage π οΈ
Setup ποΈ
- Create a github pages repo, see steps.
- Add a
_config.yml
file (or copy the one from this repo), and insert below line:remote-theme: yree/mold
- See site settings to further customize the theme.
Organization π
- The theme operates on the WYWIWYS (wee-wee-wiz) principle.
- The
README.md
at the repo root acts as the index for the GitHub Page. - To create more posts add
.md
files and folders to your repo. - Link these
.md
files across each other (refer to this repo structure).
Pro tips π‘
Site Settings
- Customize your blog further by editing the
_config.yml
file. - Adjust the blogβs name, author, theme appearance, date formatting, and more.
- The file includes comments to guide you through each customizable field.
Dark Mode for Images
- The themeβs dark mode is achieved through CSS
invert()
function. - Images arenβt inverted by default to maintain expected appearance.
- Apply
class="ioda"
to specific images to force color inversion.
Development π¦
- Run
bundle install
to set up your environment. - Start the server with
bundle exec jekyll serve
. - Modify your theme and content as needed, preview your theme at http://localhost:4000.
- Only specific files and directories are bundled. Adjust
mold.gemspec
to include custom directories if necessary.
Contributing π€
Feel free to report bugs or send pull requests over on GitHub at yree/mold. Please adhere to the Contributor Covenant code of conduct.
License π
The theme is available as open source under the terms of the MIT License.