Skip to content

Commit f714756

Browse files
author
jpmoormann
committed
updated docs
1 parent 1d0b402 commit f714756

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,26 +6,26 @@ Jerpy is a simple, flat-file, PHP CMS built for control and simplicity that is e
66

77
The CMS was built to be as streamlined and stripped-down as possible, so it's meant to be administered directly via the files.
88

9-
## Getting Started
9+
# Getting Started
1010
1. Grab the latest release and upload the files to your web root
1111
2. Create a `layouts` and `pages` directory for your site content, and rename `config.sample.json` to `config.json`
1212
3. Start creating!
1313

14-
## File Structure
14+
# File Structure
1515
There are 2 directories for content, `pages` and `layouts`, and just one file for configuration, `config.json`.
1616

17-
The `pages` directory stores the HTML/PHP content for the site, and can be used by setting the `page` property on a route to a page file path.
17+
The `pages` directory stores all the content for the site, and can be referenced as a file path on the `page` property to render the page for a route.
1818

1919
The `layouts` directory stores layout templates and their assets. The default global theme is set in `config.json` on the `layout` property.
2020

21-
## Routes
21+
# Routes
2222
Routes are defined separately from pages to easily manage the content and access of each route.
2323

2424
Each route is defined as a key on the `routes` property in `config.json`, and value is an object whose properties define the route's metadata and page content.
2525

2626
There is an optional `layout` property to render the page with a different layout template than the global default, or without one at all by setting it to `false`.
2727

28-
## Layouts
28+
# Layouts
2929
Each layout directory must have a `index.php` file and an `assets` directory. You can organize your CSS, JavaScript, fonts, and images within the `assets` directory as you see fit.
3030

3131
A handful of global variables are available for use in the `index.php` of a layout:
@@ -44,10 +44,10 @@ A handful of global variables are available for use in the `index.php` of a layo
4444
"routes": { // object: key->value store of all routes
4545
"/": { // string: route URI
4646
"title": "Home", // string: metadata title
47-
// add any additional metadata/OpenGraph properties for SEO
47+
// add any additional metadata/OpenGraph string properties for SEO (i.e., $page->meta->title in layout)
4848
"page": "pages/home.php", // string: use this to render a page file (takes preference over body)
49-
"body": "Hello, World!", // string: or use this to specify a raw response body (used if page not defined)
50-
"layout": false // string|bool: used to override the default global layout; set to false for no template
49+
"body": "Hello, World!", // string(optional): or use this to specify a raw response body (used if page not defined)
50+
"layout": false // string|bool(optional): used to override the default global layout; set to false for no layout
5151
}
5252
}
5353
}

0 commit comments

Comments
 (0)