forked from aaranxu/tale-zola
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
d7a1cf3
commit da1c328
Showing
2 changed files
with
28 additions
and
56 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,42 +1,29 @@ | ||
| # 🦎 Mabuya | ||
| <!-- # 🦎 Mabuya --> | ||
|
|
||
| <p align=""> | ||
| <div align="center"> | ||
| <h1>🦎 Mabuya</h1> | ||
| <img src="https://img.shields.io/github/languages/code-size/semanticdata/mabuya" /> | ||
| <img src="https://img.shields.io/github/repo-size/semanticdata/mabuya" /> | ||
| <img src="https://img.shields.io/github/commit-activity/t/semanticdata/mabuya" /> | ||
| <img src="https://img.shields.io/github/last-commit/semanticdata/mabuya" /> | ||
| <img src="https://img.shields.io/website/https/mabuya.vercel.app.svg" /> | ||
| </p> | ||
| </div> | ||
|
|
||
| [Mabuya](https://mabuya.vercel.app/) is a minimal [Zola](https://www.getzola.org/) theme focused on helping you build an elegant, fast, lightweight, and SEO-ready blog. Put your work front and center with Mabuya as the base of your project. | ||
| [Mabuya](https://mabuya.vercel.app/) is a minimal [Zola](https://www.getzola.org/) theme for building light and SEO-ready blogs. Put your work front and center with Mabuya as the base of your project. | ||
|
|
||
| Check out the live [demo](https://mabuya.vercel.app/) of the theme. | ||
| Check out the [demo](https://mabuya.vercel.app/). | ||
|
|
||
| ## Table of Contents | ||
| ## 📷 Screenshot | ||
|
|
||
| - [🦎 Mabuya](#-mabuya) | ||
| - [Table of Contents](#table-of-contents) | ||
| - [Screenshot](#screenshot) | ||
| - [Background](#background) | ||
| - [Features and Improvements](#features-and-improvements) | ||
| - [Running the Site Locally](#running-the-site-locally) | ||
| - [Customization](#customization) | ||
| - [Reporting Issues](#reporting-issues) | ||
| - [Contributing](#contributing) | ||
| - [Attributions](#attributions) | ||
| - [License](#license) | ||
| <img alt="Website Screenshot" src="screenshot-alt.png" width="720px" /> | ||
|
|
||
| ## Screenshot | ||
| ## ℹ Background | ||
|
|
||
| <img alt="Website Screenshot" src="screenshot.png" width="720px" /> | ||
| While searching for themes, I came across [Zola Tale](https://github.com/aaranxu/tale-zola). Sadly, the project's last update was on Dec, 2021. Shortly after, I decided to fork the project and add my own touches to it. | ||
|
|
||
| ## Background | ||
| The name **Mabuya** comes from the [Mabuya hispaniolae](https://en.wikipedia.org/wiki/Mabuya_hispaniolae?useskin=vector), a possibly extinct[^1] species of skink endemic to the Dominican Republic, my home country. | ||
|
|
||
| While searching for themes, I came across [Zola Tale](https://github.com/aaranxu/tale-zola). Sadly, the project's last update was on Dec 4, 2021. Shortly after, I decided to fork the project and add my own touches to it. | ||
|
|
||
| The name Mabuya comes from the [Mabuya hispaniolae](https://en.wikipedia.org/wiki/Mabuya_hispaniolae?useskin=vector), a possibly extinct[^1] species of skink endemic to the Dominican Republic, my home country. | ||
|
|
||
| ## Features and Improvements | ||
| ## ✨ Features and Improvements | ||
|
|
||
| While working on the theme, I have added new functionality and made many quality of life improvements. Here's a short list: | ||
|
|
||
|
|
@@ -52,67 +39,52 @@ While working on the theme, I have added new functionality and made many quality | |
| - Optimized for speed and accessibility. Subtle color changes to make the text more readable, etc. | ||
| - Many other small improvements... | ||
|
|
||
| ## Running the Site Locally | ||
|
|
||
| Tips that will help you develop and preview the site locally. | ||
| ## 🚀 Quick Start | ||
|
|
||
| ### Requirements | ||
| Before using the theme, you need to install [Zola](https://www.getzola.org/documentation/getting-started/installation/) ≥ v0.18.0. | ||
|
|
||
| Before using the theme, you need to install [Zola](https://www.getzola.org/documentation/getting-started/installation/) ≥ 0.18.0. | ||
|
|
||
| ### Quick Start | ||
|
|
||
| ```bash | ||
| # clone the repo | ||
| ```sh | ||
| # 1. Clone the repo | ||
| git clone [email protected]:semanticdata/mabuya.git | ||
| # change directory into the cloned folder | ||
|
|
||
| # 2. Change directory into clone | ||
| cd mabuya | ||
| # serve the site locally | ||
|
|
||
| # 3. Serve the site locally | ||
| zola serve | ||
| # open http://127.0.0.1:1111/ in the browser | ||
|
|
||
| # 4. Open http://127.0.0.1:1111/ in the browser | ||
| ``` | ||
|
|
||
| For more detailed instructions, visit the [Documentation](https://www.getzola.org/documentation/themes/installing-and-using-themes/) page about installing and using themes. | ||
|
|
||
| ### Useful Commands | ||
|
|
||
| A short list of commands that will help you develop your own version of the theme. | ||
|
|
||
| | Command | Description | | ||
| | -------------------------- | -------------------------- | | ||
| | `zola init <repo-name>` | Initiate new Zola site | | ||
| | `zola build` | Build only | | ||
| | `zola serve` | Build and Serve | | ||
|
|
||
| ## Customization | ||
| ## 🎨 Customization | ||
|
|
||
| You can changed the configuration, templates and content yourself. Refer to the `config.toml`, and templates files 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 tyhe [Zola Documentation](https://www.getzola.org/documentation/getting-started/overview/). | ||
|
|
||
| ### Custom CSS Styles | ||
|
|
||
| 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. | ||
|
|
||
| ## Reporting Issues | ||
| ## 🚩 Reporting Issues | ||
|
|
||
| We use GitHub Issues as the official bug tracker for **Mabuya**. Please | ||
| search [existing issues](https://github.com/semanticdata/mabuya/issues). It’s | ||
| possible someone has already reported the same problem. | ||
|
|
||
| If your problem or idea is not addressed yet, [open a new issue](https://github.com/semanticdata/mabuya/issues/new). | ||
|
|
||
| ## Contributing | ||
| ## 🤝 Contributing | ||
|
|
||
| We'd love your help! Please see [CONTRIBUTING](./CONTRIBUTING.md) to learn about the kinds of contributions we're looking for. | ||
|
|
||
| Please read and be aware of the [Code of Conduct](.github/CODE_OF_CONDUCT.md) before contributing. | ||
|
|
||
| ## Attributions | ||
| ## 💜 Acknowledgements | ||
|
|
||
| Mabuya is a fork of [Tale](https://github.com/aaranxu/tale-zola), which itself is a port of the Jekyll theme [Tale](https://github.com/chesterhow/tale) which is now archived. | ||
| Mabuya is a *fork* of [Tale](https://github.com/aaranxu/tale-zola), which itself is a *port* of the Jekyll theme [Tale](https://github.com/chesterhow/tale) which is now archived. | ||
|
|
||
| The icons used throughout the site are kindly provided by [UXWing](https://uxwing.com/license/). Read their [license](https://uxwing.com/license/). | ||
|
|
||
| ## License | ||
| ## ©️ License | ||
|
|
||
| Source code in this repository is available under the [MIT License](LICENSE). | ||
|
|
||
|
|
||
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.