diff --git a/README.md b/README.md index 8c4b1a9af0..644b3992b9 100644 --- a/README.md +++ b/README.md @@ -1,86 +1,57 @@ -# πŸ“š Minimal - -

+

+

πŸ“š Minimal

-

+
-[Minimal](https://zola-minimal.vercel.app/) is a [Zola](https://www.getzola.org) theme with the goal of helping you build a light, fast, and SEO ready landing page or website. It is based on the [Jekyll](https://jekyllrb.com/) theme with [the same name](https://github.com/pages-themes/minimal). +
-Check out the [demo](https://zola-minimal.vercel.app/). +[Minimal](https://zola-minimal.vercel.app/) is a [Zola](https://www.getzola.org) theme with the goal of helping you build a light, fast, and SEO ready landing page or website. -## Table of Contents +It is based on the [Jekyll](https://jekyllrb.com/) theme with [the same name](https://github.com/pages-themes/minimal). -- [πŸ“š Minimal](#-minimal) - - [Table of Contents](#table-of-contents) - - [Screenshots](#screenshots) - - [Getting Started](#getting-started) - - [Configuration](#configuration) - - [Reporting Issues](#reporting-issues) - - [Attributions](#attributions) - - [License](#license) +Check out the [demo](https://zola-minimal.vercel.app/). -## Screenshots +
![theme screenshot](screenshot.png) -## Getting Started - -Tips that will help you develop and preview the site locally. - -### Requirements - -Before using the theme, you need to install [Zola](https://www.getzola.org/documentation/getting-started/installation/) β‰₯ 0.18.0. +## πŸš€ Quick Start -### Quick Start +Before using the theme, you need to install [Zola](https://www.getzola.org/documentation/getting-started/installation/) β‰₯ v0.18.0. ```sh -# Clone the repo -git clone git@github.com:semanticdata/zola-minimal.git +# 1. Clone the repo +git clone git@github.com:semanticdata/mabuya.git -# Change directory into the cloned folder -cd zola-minima +# 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 ` | Initiate new Zola site | -| `zola build` | Build only | -| `zola serve` | Build and Serve | - -## Configuration - -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 the [Zola Documentation](https://www.getzola.org/documentation/getting-started/overview/). - -### Custom CSS Styles +## 🎨 Customization -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. +You can change the configuration, templates and content yourself. Refer to the [config.toml](config.toml), and [templates](templates) for ideas. In most cases you only need to modify the contents of [config.toml](config.toml) to customize the appearance of your blog. Make sure to visit the Zola [Documentation](https://www.getzola.org/documentation/getting-started/overview/). -## Reporting Issues +Adding custom CSS is as easy as adding your styles to [sass/_custom.scss](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. -We use GitHub Issues as the official bug tracker for **Minimal**. Please -search [existing issues](https://github.com/semanticdata/zola-minimal/issues). It’s possible someone has already reported the same problem. +## 🚩 Reporting Issues -If your problem or idea is not addressed yet, [open a new issue](https://github.com/semanticdata/zola-minimal/issues/new). +We use GitHub Issues as the official bug tracker for **Minimal**. Please search [existing issues](https://github.com/semanticdata/zola-minimal/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/zola-minimal/issues/new). -## Attributions +## πŸ’œ Acknowledgements Zola Minimal is a fork of the Jekyll theme [Minimal](https://github.com/pages-themes/minimal). -## License +## Β© License Source code in this repository is available under the [MIT License](LICENSE).