Skip to content

Latest commit

 

History

History
145 lines (103 loc) · 5.69 KB

README.md

File metadata and controls

145 lines (103 loc) · 5.69 KB
Raw

🦎 Mabuya


Mabuya is a lightweight Zola theme for creating fast, SEO-optimized blogs.
Put your work front and center with Mabuya as the base of your project.

demo

screenshot

ⓘ Background

While searching for themes, I stumbled upon Tale. Unfortunately, the last update was on December, 2021. Soon after, I decided to fork the project and add my own touches to it.

The name Mabuya comes from the Mabuya hispaniolae, a possibly extinct1 species of skink endemic to the Dominican Republic, my home country.

✨ Features

  • ✅ Simple Blog
  • ✅ Pagination
  • ✅ Tags
  • ✅ Dark Theme and Toggle
  • ✅ Back-to-Top Button

📈 Improvements

While working on the theme, I have added new functionality and made many quality of life improvements. Here's a short list:

  • Refactored stylesheets to make it easier to grok.
  • Added a dark theme and toggle.
  • Added new footer navigation.
  • Created a custom GitHub Action to deploy Zola sites faster than any other GitHub Actions without using Docker.
  • Refined page transitions from desktop to mobile and viceversa.
  • Centralized custom variables to make it easier to customize the site's colors.
  • Addressed PR #7 fixing the pagination problem present in the original Zola theme.
  • Addressed Issue #4 fixing custom text not being used correctly.
  • Addressed (temporarily) Issue #1 by removing the erroneous pinned marker.
  • Optimized for speed and accessibility. Subtle color changes to make the text more readable, etc.
  • Many other small improvements eventually resulting in a perfect PageSpeed Insights score:
PageSpeed Insights Results

🚀 Quick Start

Before using the theme, you need to install Zola ≥ v0.18.0. After which you'll need to:

  1. Clone the repository:
git clone [email protected]:semanticdata/mabuya.git
  1. Change directory into new cloned repository:
cd mabuya
  1. Serve the site locally:
zola serve

For more detailed instructions, visit the documentation page about installing and using themes.

🎨 Customization

You can change the configuration, templates and content yourself. Refer to the config.toml, and templates for ideas. In most cases you only need to modify the contents of config.toml to customize the appearance of your blog. Make sure to visit the Zola Documentation.

Adding custom CSS is as easy as adding your styles to sass/_custom.scss. This is made possible because SCSS files are backwards compatible with CSS. This means you can type normal CSS code into a SCSS file and it will be valid.

🔄 Workflows

🔨 Build only

steps:
  - name: Checkout
    uses: actions/checkout@v4
  - name: Install Zola
    uses: taiki-e/install-action@zola
  - name: Build Zola
    run: zola check --drafts
    env:
      BUILD_ONLY: true
      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

📢 Deployment

steps:
  - name: Checkout
    uses: actions/checkout@v4
  - name: Install Zola
    uses: taiki-e/install-action@zola
  - name: Build site
    run: zola build
    env:
      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
  - name: Upload site artifact
    uses: actions/upload-pages-artifact@v3
    with:
      path: public
  - name: Deploy to GitHub Pages
    id: deployment
    uses: actions/deploy-pages@v4

🚩 Reporting Issues

We use GitHub Issues as the official bug tracker for Mabuya. Please search existing issues. It’s possible someone has already reported the same problem. If your problem or idea is not addressed yet, open a new issue.

🤝 Contributing

We'd love your help! Please see CONTRIBUTING and our Code of Conduct before submitting a Pull Request.

💜 Acknowledgements

Mabuya is a fork of Tale, which itself is a port of the Jekyll theme Tale which is now archived.

The icons used throughout the site are kindly provided by UXWing. Read their license.

©️ License

Source code in this repository is available under the MIT License.

Footnotes

  1. Mabuya hispaniolae's conservation status is Critically endangered, possibly extinct. ↩