fundamental 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4c24efacbd4a874fa577acff1ae7438996ff53a0
-  data.tar.gz: 82d2877b9df2d41abaa79362e651dab846cd5346
+  metadata.gz: 3c9ebb73fb2eb6b7690d0b3884ab6632ba5705e6
+  data.tar.gz: 394e4f00de333a9cc3fd470b9089a43e2e124049
 SHA512:
-  metadata.gz: e6276b0cc4f6cc6a5df29795d8f164ce74c380e685ade583a0d3964571fc913e6b6ab3b0b3bb87401606c5f0ef25295a0e65bf837f8085cf2aa8e4ecc4e0ffa3
-  data.tar.gz: 85ae16d50901c96911e8bf4891838aedd8e44a8db01ae82bac4bcfb8200bae5453f1a500b117eb3db281d29cc707559f893ca8802eaa2a158c3550377d1957dc
+  metadata.gz: 552d3752b12ab6927e1dd9d036b79833b6a1677114b79835d8d5e1377c530d53d3faebec51bd74f62fe77955c97102b5738cef88e52078717900291ad7051111
+  data.tar.gz: 477d2dc7a8bdbd3905243214e9a73152f3fe0da96a96bf0561ba3129894b9ef1e88435ae5db3df5d6fcb0b3e12335559450b97e29d6a897607893f77b4bf9be4

data/README.md

@@ -43,7 +43,18 @@ Or install it yourself as:
 
 ### Getting Started
 
-After installing you should have a `config.yml` file in your base directory. If not, [grab the default one from the repository](https://github.com/theomjones/fundamental/blob/master/_config.yml).
+After installing you should have a `config.yml` file in your base directory. Copy the contents of the repo [config.yml](https://github.com/theomjones/fundamental/blob/master/_config.yml) into your own config file. This will supply you with all the required configurations. You can edit them from here.
+
+Jekyll gives you an `index.md` file as your homepage. Copy this into it to get started, the front matter will be explained below:  **!! Something to note**, Fundamental does not currently support categories (they're coming!). The default page Jekyll produces will break breadcrumbs (for now).
+
+	---
+	layout: blog
+	title: Home
+	menu: true
+	order: 1
+	---
+	
+If you want to add the 'Archive' file you see in the demo. Create an `/archive` directory in your base directory. Then create an `index.md` inside it. Ensure it has the `layout: site-archive`. This layout displays all the posts in the site.
 
 ##### Plugins
 Fundamemtal uses these plugins. When you have installed the Fundamental gem, run `bundle install` to install the required plugins. They can be turned on and off in your configuration file.
@@ -72,7 +83,7 @@ enabled:
 ```
 
 #### Layouts
-For blog posts use the `post.html` layout (this is already set as default via config file.) For normal pages use the `page.html` layout. Naturally, the blog layout is used for the blog page on the home screen. All of these layouts inherit from the `default` layout.
+For blog posts use the `post.html` layout (this is already set as default via config file.) For normal pages use the `page.html` layout. Naturally, the blog layout is used for the blog page on the home screen. All of these layouts inherit from the `default` layout, which contains the head and footer includes.
 
 The other layouts are for the `jekyll-archives` plugin.
 
@@ -85,6 +96,7 @@ The other layouts are for the `jekyll-archives` plugin.
 	│   ├── month.html
 	│   ├── page.html
 	│   ├── post.html
+	|   ├── site-archive.html
 	│   └── tag_page.html
 		
 	
@@ -155,4 +167,5 @@ The theme is available as open source under the terms of the [MIT License](https
 ![alt text](http://theomjones.com/fundamental/assets/images/screenshot2.png)
 
 ### 404 Page
-![alt text](http://theomjones.com/fundamental/assets/images/screenshot3.png)
+![alt text](http://theomjones.com/fundamental/assets/images/screenshot3.png)
+[You can get this 404 page from the repo to use in your site.](https://github.com/theomjones/fundamental/blob/master/404.html) Just copy it into your main directory.

data/_layouts/site-archive.html

@@ -0,0 +1,12 @@
+---
+layout: default
+---
+
+<h1>All Posts</h1>
+<ul>
+  {% for post in site.posts %}
+    <li><a href="{{ site.baseurl }}/{{ post.url }}">{{ post.title }}</a>
+      <span> - {{ post.date | date_to_string }}</span>
+    </li>
+  {% endfor %}
+</ul>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fundamental
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Theo M Jones
@@ -102,6 +102,7 @@ files:
 - _layouts/month.html
 - _layouts/page.html
 - _layouts/post.html
+- _layouts/site-archive.html
 - _layouts/tag_page.html
 - _sass/_blog.scss
 - _sass/_footer.scss