• Stars
    star
    14,248
  • Rank 1,977 (Top 0.05 %)
  • Language
    PHP
  • License
    MIT License
  • Created over 9 years ago
  • Updated 10 days ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Modern, Crazy Fast, Ridiculously Easy and Amazingly Powerful Flat-File CMS powered by PHP, Markdown, Twig, and Symfony

Grav

PHPStan Discord PHP Tests OpenCollective OpenCollective OpenCollective

Grav is a Fast, Simple, and Flexible, file-based Web-platform. There is Zero installation required. Just extract the ZIP archive, and you are already up and running. It follows similar principles to other flat-file CMS platforms, but has a different design philosophy than most. Grav comes with a powerful Package Management System to allow for simple installation and upgrading of plugins and themes, as well as simple updating of Grav itself.

The underlying architecture of Grav is designed to use well-established and best-in-class technologies to ensure that Grav is simple to use and easy to extend. Some of these key technologies include:

Requirements

Documentation

The full documentation can be found from learn.getgrav.org.

QuickStart

These are the options to get Grav:

Downloading a Grav Package

You can download a ready-built package from the Downloads page on https://getgrav.org

With Composer

You can create a new project with the latest stable Grav release with the following command:

$ composer create-project getgrav/grav ~/webroot/grav

From GitHub

  1. Clone the Grav repository from https://github.com/getgrav/grav to a folder in the webroot of your server, e.g. ~/webroot/grav. Launch a terminal or console and navigate to the webroot folder:

    $ cd ~/webroot
    $ git clone https://github.com/getgrav/grav.git
    
  2. Install the plugin and theme dependencies by using the Grav CLI application bin/grav:

    $ cd ~/webroot/grav
    $ bin/grav install
    

Check out the install procedures for more information.

Adding Functionality

You can download plugins or themes manually from the appropriate tab on the Downloads page on https://getgrav.org, but the preferred solution is to use the Grav Package Manager or GPM:

$ bin/gpm index

This will display all the available plugins and then you can install one or more with:

$ bin/gpm install <plugin/theme>

Updating

To update Grav you should use the Grav Package Manager or GPM:

$ bin/gpm selfupgrade

To update plugins and themes:

$ bin/gpm update

Upgrading from older version

Contributing

We appreciate any contribution to Grav, whether it is related to bugs, grammar, or simply a suggestion or improvement! Please refer to the Contributing guide for more guidance on this topic.

Security issues

If you discover a possible security issue related to Grav or one of its plugins, please email the core team at [email protected] and we'll address it as soon as possible.

Getting Started

Exploring More

Backers

Support Grav with a monthly donation to help us continue development. [Become a backer]

Supporters

Support Grav with a monthly donation to help us continue development. [Become a supporter]

Sponsors

Support Grav with a yearly donation to help us continue development. [Become a sponsor]

License

See LICENSE

Running Tests

First install the dev dependencies by running composer install from the Grav root.

Then composer test will run the Unit Tests, which should be always executed successfully on any site. Windows users should use the composer test-windows command. You can also run a single unit test file, e.g. composer test tests/unit/Grav/Common/AssetsTest.php

To run phpstan tests, you should run:

  • composer phpstan for global tests
  • composer phpstan-framework for more strict tests
  • composer phpstan-plugins to test all installed plugins

More Repositories

1

grav-plugin-admin

Grav Admin Plugin
PHP
351
star
2

grav-learn

Grav Learn (exhaustive grav documentation)
SCSS
226
star
3

docker-grav

Official Docker Image for Grav
Dockerfile
189
star
4

awesome-grav

A curated list of awesome stuff to do with Grav
123
star
5

grav-skeleton-rtfm-site

Grav RTFM Skeleton
80
star
6

grav-theme-learn2

Learn2 Grav Theme
SCSS
80
star
7

grav-theme-quark

SCSS
63
star
8

grav-skeleton-resume-site

Resume Skeleton for Grav
58
star
9

grav-theme-antimatter

Grav Antimatter Theme
SCSS
56
star
10

grav-plugin-comments

Grav Comments Plugin
PHP
56
star
11

grav-theme-resume

Resume Theme for Grav
JavaScript
53
star
12

grav-plugin-form

Grav Form Plugin
PHP
53
star
13

grav-skeleton-blog-site

Grav Blog Site Skeleton
48
star
14

grav-plugin-shortcode-ui

Grav Shortcode UI Plugin
CSS
47
star
15

grav-theme-ceevee

Ceevee is a clean, modern, fully responsive site template for your resume and portfolio. With this template, you can easily introduce yourself and showcase your works to future clients and employers. Also, it is flexible and easy to customize so you even use this template as a creative, business or portfolio site for your company.
CSS
46
star
16

grav-plugin-shortcode-core

Grav Shortcode Core Plugin
JavaScript
45
star
17

grav-plugin-login

Grav Login Plugin
PHP
44
star
18

grav-plugin-simplesearch

Grav SimpleSearch Plugin
PHP
42
star
19

grav-plugin-sitemap

Grav Sitemap Plugin
PHP
42
star
20

grav-plugin-devtools

Grav Devtools Plugin
Twig
37
star
21

grav-plugin-email

Grav Email Plugin
PHP
36
star
22

grav-plugin-markdown-notices

Grav Markdown Notices Plugin
PHP
32
star
23

grav-skeleton-ceevee-site

Ceevee is a clean, modern, fully responsive site template for your resume and portfolio. With this template, you can easily introduce yourself and showcase your works to future clients and employers. Also, it is flexible and easy to customize so you even use this template as a creative, business or portfolio site for your company.
32
star
24

grav-plugin-page-inject

Grav Page Inject Plugin
JavaScript
31
star
25

grav-plugin-featherlight

Grav Featherlight Plugin
PHP
30
star
26

grav-plugin-data-manager

Grav Data Manager Plugin
PHP
30
star
27

grav-theme-landio

Land.io is a carefully crafted landing page UI kit and landing page template built on Bootstrap 4, designed by Peter Finlan and developed by Taty Grassini.
JavaScript
30
star
28

grav-skeleton-deliver-site

Grav Deliver Site Skeleton
28
star
29

grav-theme-deliver

Grav Deliver Theme
SCSS
27
star
30

grav-theme-agency

Agency Theme for Grav
CSS
27
star
31

grav-plugin-highlight

Grav Highlight Plugin
JavaScript
27
star
32

grav-plugin-pagination

Grav Pagination Plugin
PHP
26
star
33

grav-plugin-langswitcher

Grav LangSwitcher Plugin
PHP
26
star
34

grav-skeleton-woo-site

Woo is a clean, modern, landing page site template. It has a fully responsive design and was tested on all major browser and mobile devices. Woo is the perfect template to showcase your apps, services or digital goods.
24
star
35

grav-skeleton-landio-site

Land.io is a carefully crafted landing page UI kit and landing page template built on Bootstrap 4, designed by Peter Finlan and developed by Taty Grassini.
23
star
36

grav-plugin-taxonomylist

Grav TaxonomyList Plugin
PHP
23
star
37

grav-skeleton-onepage-site

Grav One-Page Site Skeleton
22
star
38

grav-plugin-youtube

Grav YouTube Plugin
PHP
22
star
39

grav-plugin-advanced-pagecache

Grav AdvancedPageCache Plugin
PHP
21
star
40

grav-theme-cacti

Grav Cacti Theme
CSS
21
star
41

grav-plugin-snipcart

Grav Snipcart Plugin
Twig
19
star
42

grav-plugin-readingtime

Grav ReadingTime Plugin
PHP
19
star
43

grav-theme-boxify

"Boxify" is a Grav port of One Page Website Template by Peter Finlan for Codrops
CSS
18
star
44

grav-plugin-breadcrumbs

Grav Breadcrumbs Plugin
PHP
18
star
45

grav-plugin-login-oauth

Grav Login Plugin OAuth Add-On
PHP
18
star
46

grav-skeleton-shop-site

Grav Shop Site Skeleton
18
star
47

grav-skeleton-agency-site

Agency Skeleton for Grav
17
star
48

grav-plugin-assets

Grav Assets Plugin
PHP
17
star
49

grav-theme-bootstrap

Grav Bootstrap Theme
Twig
17
star
50

grav-theme-woo

Woo is a clean, modern, landing page site template. It has a fully responsive design and was tested on all major browser and mobile devices. Woo is the perfect template to showcase your apps, services or digital goods.
JavaScript
17
star
51

grav-plugin-feed

Grav Feed Plugin
PHP
16
star
52

grav-plugin-relatedpages

Grav RelatedPages Plugin
PHP
16
star
53

grav-plugin-cdn

Grav CDN Plugin
PHP
16
star
54

grav-plugin-maintenance

Grav Maintenance Plugin
PHP
15
star
55

grav-plugin-lightslider

Grav LightSlider Plugin
JavaScript
14
star
56

grav-theme-receptar

Receptar is simple, modern, responsive, high-DPI, fully customizable, stylish blog Grav theme.
CSS
14
star
57

grav-skeleton-twenty-site

Twenty Skeleton for Grav
13
star
58

grav-plugin-github

Grav GitHub Plugin
PHP
13
star
59

grav-theme-mediator

Mediator Grav Theme
SCSS
13
star
60

grav-theme-lingonberry

A clean, simple and responsive theme for bloggers. Features responsive design, retina ready assets, custom styling for all post formats, custom page templates and custom accent color.
CSS
13
star
61

grav-theme-gateway

Gateway incorporates elegant style with user friendly customizer options making it perfectly suited for a variety of Grav users. With rock solid development and flexible integration, the Gateway theme is sure to be a favorite for first time Grav users and experienced developers alike.
CSS
12
star
62

grav-plugin-auto-date

Grav Auto Date Plugin
PHP
12
star
63

grav-plugin-editor-buttons

Grav Editor Buttons Plugin
JavaScript
12
star
64

grav-plugin-anchors

Grav Anchors Plugin
PHP
11
star
65

grav-skeleton-hpstr-site

HPSTR Grav Skeleton
11
star
66

grav-skeleton-multilang-site

MultiLang Skeleton for Grav
11
star
67

grav-plugin-custom-css

Custom CSS Plugin: Add additional CSS to your site, without editing the theme or having to create a plugin for the simple task of adding some custom lines of sylesheets.
PHP
11
star
68

grav-plugin-shortcode-owl-carousel

Grav Shortcode Owl Carousel Plugin
CSS
11
star
69

grav-skeleton-saturn-site

Saturn – Free Grav Theme, is a beautiful cosmic website template. Customize it easily and add your own creative touch. Designed by Afnizar Nur Ghifari
10
star
70

grav-plugin-problems

Grav Problems Plugin
SCSS
10
star
71

grav-plugin-bootstrapper

Grav Bootstrapper Plugin
JavaScript
10
star
72

grav-theme-saturn

Saturn – Free Grav Theme, is a beautiful cosmic website template. Customize it easily and add your own creative touch. Designed by Afnizar Nur Ghifari
JavaScript
10
star
73

grav-theme-pinpress

PinPress is a creative Flat Blog/Magazine blogger template and it is the perfect choice for professionals who’s looking for a magazine template or a personal, niche, corporate, and marketing blogs. PinPress blogger template is highly customizable so it can match your personal taste and be quickly converted into a multi-purpose theme as well.
CSS
10
star
74

grav-skeleton-mediator-site

Grav Skeleton Mediator
9
star
75

grav-plugin-file-content

Grav File Content Plugin
PHP
9
star
76

grav-plugin-database

PHP
8
star
77

grav-plugin-markdown-color

Grav Markdown Color Plugin
PHP
8
star
78

grav-skeleton-photographer-site

Modern photography portfolio.
8
star
79

grav-skeleton-striped-site

Striped by HTML5 UP, features a clean, minimalistic design, styling for all basic page elements, a repositionable sidebar (left or right), and HTML5/CSS3 code designed for quick and easy customization.
8
star
80

grav-theme-learn4

SCSS
8
star
81

grav-skeleton-receptar-site

Receptar Skeleton for Grav - Receptar is simple, modern, responsive, high-DPI, fully customizable, stylish blog Grav theme.
8
star
82

grav-skeleton-soraarticle-blog

Sora Article is a minimal Theme designed for blogger, ported to Grav.
8
star
83

grav-plugin-archives

Grav Archives Plugin
PHP
8
star
84

grav-skeleton-notepad-site

Grav Notepad Site Skeleton
8
star
85

grav-skeleton-lingonberry-site

A clean, simple and responsive theme for bloggers. Features responsive design, retina ready assets, custom styling for all post formats, custom page templates and custom accent color.
8
star
86

grav-skeleton-halcyon-site

Halcyon Days is a modern and stylish HTML5/CSS3 template with a pixel-perfect design and smooth effects. It’s especially fitting for a portfolio or start-up website, but it’s also very versatile and can be used for many other projects.
8
star
87

grav-skeleton-gateway-site

Gateway incorporates elegant style with user friendly customizer options making it perfectly suited for a variety of Grav users. With rock solid development and flexible integration, the Gateway theme is sure to be a favorite for first time Grav users and experienced developers alike.
8
star
88

grav-premium-issues

Official Grav Premium Issues repository to report problems or ask questions regarding the Premium products offered.
7
star
89

grav-plugin-precache

Grav PreCache Plugin
PHP
7
star
90

grav-theme-hpstr

HPSTR Grav Theme
JavaScript
7
star
91

grav-plugin-shortcode-assets

PHP
7
star
92

grav-skeleton-pinpress-site

PinPress is a creative Flat Blog/Magazine grav theme and it is the perfect choice for professionals who’s looking for a magazine theme or a personal, niche, corporate, and marketing blogs. PinPress grav theme is highly customizable so it can match your personal taste and be quickly converted into a multi-purpose theme as well.
7
star
93

grav-plugin-random

Grav Random Plugin
PHP
6
star
94

skeleton-builder

GitHub Action to create fully functional skeleton packages that include all the necessary dependencies
Shell
6
star
95

grav-theme-notepad

Notepad Grav Theme
CSS
6
star
96

grav-theme-photographer

Photographer Theme for Grav - Modern photography portfolio.
JavaScript
6
star
97

grav-theme-twenty

Grav Twenty Theme
CSS
5
star
98

grav-plugin-star-ratings

Grav Star Ratings Plugin
PHP
5
star
99

grav-skeleton-boxify-site

"Boxify" is a Grav port of One Page Website Template by Peter Finlan for Codrops
5
star
100

grav-theme-twentyfifteen

TwentyFifteen Theme for Grav
CSS
5
star