GithubHelp home page GithubHelp logo

grav-theme-masonry's Introduction

Masonry Grav Theme

Masonry

The Masonry theme for Grav is a direct port of the Masonry Theme for Ghost designed by Chris Brown.

Installation

Installing the Masonry theme can be done in one of two ways. With GPM (Grav Package Manager) installation method enables you to quickly and easily install the theme with a simple terminal command, while the manual method enables you to do so via a zip file.

GPM Installation (Preferred)

The simplest way to install this theme is via the Grav Package Manager (GPM) through your system's Terminal (also called the command line). From the root of your Grav install type:

bin/gpm install masonry

This will install the Masonry theme into your /user/themes directory within Grav. Its files can be found under /your/site/grav/user/themes/masonry.

Manual Installation

To install this theme, just download the zip version of this repository and unzip it under /your/site/grav/user/themes. Then, rename the folder to masonry.

You should now have all the theme files under

/your/site/grav/user/themes/masonry

Dependencies

This theme requires Pagination plugin. Supports Disqus or Comments plugin. And i highly recommend Grav Admin plugin.

Skeleton

The theme works best in combination with appropriate content and configuration. Please check out the Mediator Skeleton Package.

Pages Hierarchy

your/site/user/pages should look like:

├── 01.blog (Main folder for blog posts)
│   ├── default.md (blog settings)
|   |── header.jpg (blog cover image if you want to)
|   |
│   ├── post-with-cover (folder for a blog post)
│   │   ├── post.md
│   │   └── unsplash.jpg
│   ├── tooling-grunt (folder for a blog post)
│   │   └── post.md
|
└── 02.about (Page Folder)
    └── page.md

Configuration

Open the your/site/user/data/site.yaml file and add/replace these lines.

# Home Page Title
title: 'Mesut Koca · Web Developer'
description: 'Thoughts, stories and ideas.'

author:
  name: 'Mesut Koca'
  email: [email protected]
  # Avatar image optional (under your/site/user/themes/masonry/images/avatar.png)
  image: avatar.png
  # Optional
  link: 'https://twitter.com/twitterusername'
  # Optional
  location: Poland
  # Optional
  bio: 'Type something cool here.'


# Optional
disqus: disqususername
# Optional (under your/site/user/themes/masonry/images/logofile.png)
logo: logofile.png

Blog Settings

Sample your/site/user/pages/01.blog/default.md file


---
#cover: header.jpg  this is optional...
sitemap:
    changefreq: weekly
    priority: 1.03
content:
    items: '@self.children'
    order:
        by: date
        dir: desc
    limit: 8
    pagination: true
feed:
    description: 'Sample Blog Description'
    limit: 3
pagination: true
---

Cover Image for Blog Home Page

Go to the your/site/user/pages/01.blog/default.md file and add this line:

cover: header.jpg

Cover Images for Posts

If you want to add cover images to your pages or posts add image: covername.jpg to your markdown file. Like so:

---
title: 'Tooling: Grunt'
image: yourimagefile.png
---
Lorem ipsum your post....

Language

English, German and French languages are supported out of the box. If you want to add your language, edit the languages.yaml file. And don't forget to send a Pull Request :)

Updating

As development for the Masonry theme continues, new versions may become available that add additional features and functionality, improve compatibility with newer Grav releases, and generally provide a better user experience. Updating Masonry is easy, and can be done through Grav's GPM system, as well as manually.

GPM Update (Preferred)

The simplest way to update this theme is via the Grav Package Manager (GPM). You can do this with this by navigating to the root directory of your Grav install using your system's Terminal (also called command line) and typing the following:

bin/gpm update masonry

This command will check your Grav install to see if your Masonry theme is due for an update. If a newer release is found, you will be asked whether or not you wish to update. To continue, type y and hit enter. The theme will automatically update and clear Grav's cache.

Manual Update

Manually updating Masonry is pretty simple. Here is what you will need to do to get this done:

  • Delete the your/site/user/themes/masonry directory.
  • Downalod the new version of the Masonry theme from either GitHub or GetGrav.org.
  • Unzip the zip file in your/site/user/themes and rename the resulting folder to masonry.
  • Clear the Grav cache. The simplest way to do this is by going to the root Grav directory in terminal and typing bin/grav clear-cache.

Note: Any changes you have made to any of the files listed under this directory will also be removed and replaced by the new set. Any files located elsewhere (for example a YAML settings file placed in user/config/themes) will remain intact.

Setup

If you want to set Masonry as the default theme, you can do so by following these steps:

  • Navigate to /your/site/grav/user/config.
  • Open the system.yaml file.
  • Change the theme: setting to theme: masonry.
  • Save your changes.
  • Clear the Grav cache. The simplest way to do this is by going to the root Grav directory in Terminal and typing bin/grav clear-cache.

Once this is done, you should be able to see the new theme on the frontend. Keep in mind any customizations made to the previous theme will not be reflected as all of the theme and templating information is now being pulled from the Masonry folder.


License

This theme is free and open source software, distributed under the MIT License

grav-theme-masonry's People

Contributors

avantar avatar core77 avatar funilrys avatar koca avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

grav-theme-masonry's Issues

Default.html.twig doesn't list child pages properly.

Page.collection() on line 2 is seemingly empty for some reason. Changing it to page.children() fixes the issue, but I'm wondering what is causing this? Between today and the last time I worked on my site using Masonry 10 days ago, nothing was changed in the code and then it broke when I tried to add a new gallery posts container page.

Upgrade foundation and create internal page

Hi, i hope this project is not abandoned, i would like update the foundation (seem think it works with this) and i'd like to know if possible create a varios page internal site as homepage, contact, ecc...
Becouse when i try a create homepage with simple html the page is white.

Wrong site name

In default.html.twig on line 18 is an error

Current value:

<h1 class="page-title">{{ site.author.name }}</h1>

Must be this:

<h1 class="page-title">{{ site.title }}</h1>

Change font size

Good morning,
I am a beginner in setting up a site.
I installed the Masonry theme only I'd like to change the font size.
I understand it's in a CSS file but I don't see where to go at all...
If someone could help me, I'd be grateful.
thank you in advance.

CSS Stylesheets not imported correctly

I had an issue with this theme in that the stylesheets were not correctly imported, they were parsed as &lt;style ... in HTML etc. I fixed this problem by changing lines 29ff of base.html.twig to the following.

        {% block stylesheets %}
            {% do assets.addCss('theme://css/screen.css') %}
        {% endblock %}
        {% block assets deferred %}
            {{ assets.css()|raw }}
        {% endblock %}

header author

Maybe you can use the theme-variable {{ page.header.author }} to display the author?

Sincerely Benny

Posts don't show up

Right know my Grav site won't show any posts just an empty white site with the authors name as a headline an the footer. Pagination plugin is installed as well.
Maybe you could provide a complete skeleton so it's easier to figure out what's missing.

Also did you test it with the upcoming v.1.1 of Grav?

Is skeleton available?

Do you have a skeleton for this theme?

The skeleton link in README is linked to Mediator theme's skeleton.

I don't see my content

I only see menu, header title, and footer , no content is present,
upon switching to your theme.

Please advise.

Adding to the menu

I'm new to Grav and cant work out how can I create pages and then add to the menu?

Author Image not shown

Hi!

I just installed masonry theme after configuring mediator sceleton, but I can not get my avater shown up. In with folder do I need to place the jpg?

In user/config/site.yaml I defined image: avatar.jpg

Anything else works great so far. this theme could be the one I will stay on =)

Summary not work

Hi,
I want to use the summary function. I use '===' as a delimiter.
The theme does not interpret this

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.