Getting Started with Grav

Expected Technical Skills
  • Markdown or HTML basics
  • Understanding folder hierarchies (i.e. relative links)
Web Installation

Pre-flight Checklist

  1. Confirm Web server PHP version (PHP 5.5.9 or higher)
  2. Web server login credentials (username and password)

Installation Steps

  1. Download the Grav Workshop Demo Skeleton
  2. Unzip the package onto your desktop
  3. Copy the entire Grav folder to your Web server
  4. Point your browser to the Web server folder
  5. Create your site administrator account when prompted
  6. And you're done! (press the icon in the Admin Panel to preview site)
Desktop Installation

Pre-flight Checklist

  1. Confirm Web server PHP version (PHP 5.5.9 or higher)
  2. Download and install MAMP (mamp.info)

Desktop Installation Steps

  1. Download the Grav Workshop Demo Skeleton
  2. Unzip the Grav package onto your desktop
  3. Copy the entire Grav folder into the 'htdocs' folder within your MAMP application folder
  4. Launch MAMP
  5. Press the MAMP 'Start Servers' button
  6. Enter 'localhost:8888' as the URL in your Web Browser
  7. Choose the displayed Grav folder name
  8. Create your site administrator account when prompted
  9. And you're done! (press the icon in the Admin Panel to preview site)
Editing a Page

To edit a page, you can either use the installed Admin Panel plugin (accessed by adding '/admin/ to the URL of your Grav site) or work with files locally using a text editor of choice such as Atom.io or Adobe Brackets.

Admin Panel
Image of Grav Admin Panel
Press on the Pages button on the left-hand toolbar and then choose the Home page.

Working with Files
Navigate to the folder you installed Grav into, and then browse to the user/pages/01.home folder and open the default.md file in the text editor of your choice. You will see the content of this page in Markdown format.

Create a New Page

Admin Panel

  1. In the Pages panel press the Add Page button and then enter My Page as the Page Title. Make sure that the Page Template is set to Default.
  2. Enter the below page content of your choice on the newly created page, and then tap the Save button:

    # My New Page!
    
    This is the body of **my new page** and I can easily use _Markdown_ syntax here.

Pages in Grav can also include the content of other pages (i.e. Modular pages).

Working with Files

  1. Navigate to your pages folder: user/pages/ and create a new folder. In this example, we will use explicit default ordering and call the folder 06.another-page.
  2. Launch your text editor and paste in the following:

    ---
    title: Another Page
    ---
    # Another New Page!
    
    This is the body of **a new page** and I can easily use _Markdown_ syntax here.
  3. Save this file in the user/pages/06.another-page/ folder as default.md. This will tell Grav to render the page using the default template.
  4. That is it! Reload your browser to see your new page in the menu.

Want to learn even more about using Grav? Check out the Next Steps section!

Notice an error? Could you make this documentation better? Edit this Page