reorg, readme update, first post update, etc

poole · Dec 30, 2013 · cfec9da · cfec9da
1 parent 384c775
commit cfec9da
Show file tree

Hide file tree

Showing 9 changed files with 95 additions and 93 deletions.
diff --git a/LICENSE.md b/LICENSE.md
@@ -1,6 +1,6 @@
 # Released under MIT License
 
-Copyright (c) 2013 Mark Otto.
+Copyright (c) 2014 Mark Otto.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

diff --git a/README.md b/README.md
@@ -16,7 +16,7 @@ To get started, download [Poole](https://github.com/poole/poole). See [the usage
 
 Copy over the included files to turn any vanilla Poole site into a Lanyon site.
 
-- Replace `_includes/head.html` with the included file of the same name
+- Replace `_includes/` with the included folder of the same name (will replace `_includes/head.html` and add `_includes/sidebar.html`)
 - Replace `_layouts/default.html` with the included file of the same name
 - Move `public/css/lanyon.css` to `public/css/`
 

diff --git a/_config.yml b/_config.yml
@@ -6,10 +6,10 @@ pygments:         true
 permalink:        pretty
 
 # Setup
-title:            Did
-tagline:          'A Jekyll theme, with personalities'
-description:      'Did is a <a href="http://jekyllrb.com" target="_blank">Jekyll</a> theme with multiple personalities: the content, and the chrome. Made by <a href="https://twitter.com/mdo" target="_blank">@mdo</a>.'
-url:              http://did.andhyde.com
+title:            Lanyon
+tagline:          'A content-first, sliding sidebar theme for Jekyll'
+description:      'Lanyon is a responsive, mobile first <a href="http://jekyllrb.com" target="_blank">Jekyll</a> theme with a toggleable sidebar drawer. Made by <a href="https://twitter.com/mdo" target="_blank">@mdo</a>.'
+url:              http://lanyon.getpoole.com
 
 author:
   name:           'Mark Otto'
@@ -18,7 +18,7 @@ author:
 paginate:         5
 
 # Custom vars
-version:          1.0.0
+version:          2.0.0
 
 github:
-  repo:           https://github.com/mdo/did
+  repo:           https://github.com/poole/lanyon
diff --git a/_includes/sidebar.html b/_includes/sidebar.html
@@ -0,0 +1,38 @@
+<!-- Target for toggling the sidebar `.sidebar-checkbox` is for regular
+     styles, `#sidebar-checkbox` for behavior. -->
+<input type="checkbox" class="sidebar-checkbox" id="sidebar-checkbox">
+
+<!-- Toggleable sidebar -->
+<div class="sidebar" id="sidebar">
+  <div class="sidebar-item">
+    <p>{{ site.description }}</p>
+  </div>
+
+  <nav class="sidebar-nav">
+    <a class="sidebar-nav-item{% if page.title == "Home" %} active{% endif %}" href="/">Home</a>
+
+    {% comment %}
+      The code below dynamically generates a sidebar nav of pages with
+      `layout: page` in the front-matter. See readme for usage.
+    {% endcomment %}
+
+    {% assign pages_list = site.pages %}
+    {% for node in pages_list %}
+      {% if node.title != null %}
+        {% if node.layout == "page" %}
+          <a class="sidebar-nav-item{% if page.url == node.url %} active{% endif %}" href="{{ node.url }}">{{ node.title }}</a>
+        {% endif %}
+      {% endif %}
+    {% endfor %}
+
+    <a class="sidebar-nav-item" href="{{ site.github.repo }}/archive/v{{ site.version }}.zip">Download</a>
+    <a class="sidebar-nav-item" href="{{ site.github.repo }}">GitHub project</a>
+    <span class="sidebar-nav-item">Currently v{{ site.version }}</span>
+  </nav>
+
+  <div class="sidebar-item">
+    <p>
+      &copy; {{ site.time | date: '%Y' }}. All rights reserved.
+    </p>
+  </div>
+</div>
diff --git a/_layouts/default.html b/_layouts/default.html
@@ -5,45 +5,7 @@
 
   <body>
 
-    <!-- Target for toggling the sidebar `.sidebar-checkbox` is for regular
-         styles, `#sidebar-checkbox` for behavior. -->
-    <input type="checkbox" class="sidebar-checkbox" id="sidebar-checkbox">
-
-    <!-- Sidebar that gets toggled. `.sidebar` is for regular styles, `#sidebar`
-         for behavior. -->
-    <div class="sidebar" id="sidebar">
-      <div class="sidebar-item">
-        <p>{{ site.description }}</p>
-      </div>
-
-      <nav class="sidebar-nav">
-        <a class="sidebar-nav-item{% if page.title == "Home" %} active{% endif %}" href="/">Home</a>
-
-        {% comment %}
-          The code below dynamically generates a sidebar nav of pages with
-          `layout: page` in the front-matter. See readme for usage.
-        {% endcomment %}
-
-        {% assign pages_list = site.pages %}
-        {% for node in pages_list %}
-          {% if node.title != null %}
-            {% if node.layout == "page" %}
-              <a class="sidebar-nav-item{% if page.url == node.url %} active{% endif %}" href="{{ node.url }}">{{ node.title }}</a>
-            {% endif %}
-          {% endif %}
-        {% endfor %}
-
-        <a class="sidebar-nav-item" href="{{ site.github.repo }}/archive/v{{ site.version }}.zip">Download</a>
-        <a class="sidebar-nav-item" href="{{ site.github.repo }}">GitHub project</a>
-        <span class="sidebar-nav-item">Currently v{{ site.version }}</span>
-      </nav>
-
-      <div class="sidebar-item">
-        <p>
-          &copy; {{ site.time | date: '%Y' }}. All rights reserved.
-        </p>
-      </div>
-    </div>
+    {% include sidebar.html %}
 
     <!-- Wrap is the content to shift when toggling the sidebar. We wrap the
          content to avoid any CSS collisions with our real content. -->

diff --git a/_posts/2014-01-02-introducing-did.md b/_posts/2014-01-02-introducing-did.md
diff --git a/_posts/2014-01-02-introducing-lanyon.md b/_posts/2014-01-02-introducing-lanyon.md
@@ -0,0 +1,38 @@
+---
+layout: post
+title: Introducing Lanyon
+---
+
+Lanyon is a [Jekyll](http://jekyllrb.com) theme with a toggleable sidebar drawer for out of sight navigation. It's based on [Poole](https://github.com/poole/poole), the Jekyll butler, and is designed to showcase your content first and foremost with extraneous information hidden offscreen until the reader requests it.
+
+### Built on Poole
+
+Poole is the Jekyll Butler, serving as an upstanding and effective foundation for Jekyll themes by [@mdo](https://twitter.com/mdo). Poole, and every theme built on it (like Lanyon here) includes the following:
+
+* Complete Jekyll setup included (layouts, config, [404](/404), [RSS feed](/atom.xml), posts, and [example page](/about))
+* Mobile friendly design and development
+* Easily scalable text and component sizing with `rem` units in the CSS
+* Support for a wide gamut of HTML elements
+* Related posts (time-based, because Jekyll) below each post
+* Syntax highlighting, courtesy Pygments (the Python-based code snippet highlighter)
+
+### Lanyon features
+
+In addition to the features of Poole, Lanyon adds the following:
+
+* Toggleable sliding sidebar (built with only CSS) via **☰** link in top corner
+* Sidebar includes support for textual modules and a dynamically generated navigation with active link support
+* Two orientations for content and sidebar, default (left sidebar) and [reverse](https://github.com/poole/lanyon#reverse-layout) (right sidebar), available via `<body>` classes
+* [Eight optional color schemes](https://github.com/poole/lanyon#themes), available via `<body>` classes
+
+[Head to the readme](https://github.com/poole/lanyon#readme) to learn more.
+
+### Browser support
+
+Lanyon is by preference a forward-thinking project. In addition to the latest versions of Chrome, Safari (mobile and desktop), and Firefox, it is only compatible with Internet Explorer 9 and above.
+
+### Download
+
+Lanyon is developed on and hosted with GitHub. Head to the <a href="https://github.com/poole/lanyon">GitHub repository</a> for downloads, bug reports, and features requests.
+
+Thanks!
diff --git a/about.md b/about.md
@@ -4,31 +4,27 @@ title: About
 ---
 
 <p class="message">
-  Hey there! This page is included in Did as an example. Feel free to customize it for your own use upon downloading. Carry on!
+  Hey there! This page is included as an example. Feel free to customize it for your own use upon downloading. Carry on!
 </p>
 
-[Did](http://mdo.github.io/did) is a [Jekyll](http://jekyllrb.com) theme, designed and built by [@mdo](https://twitter.com/mdo). It started off as an optional layout for another theme, [Hyde](http://andhyde.com). The code for both layouts added too much overhead, so a new theme was created.
+In the novel, *The Strange Case of Dr. Jeykll and Mr. Hyde*, Mr. Poole is Dr. Jekyll's virtuous and loyal butler. Similarly, Poole is an upstanding and effective butler that helps you build Jekyll themes. It's made by [@mdo](https://twitter.com/mdo).
 
-## Name
+There are currently two themes built on Poole:
 
-The name *Did* originates from a rather well-known, and unsurprisingly relevant, psychiatric condition.
+* [Hyde](http://hyde.getpoole.com)
+* [Lanyon](http://lanyon.getpoole.com)
 
-> Dissociative identity disorder (<strong>DID</strong>), also known as multiple personality disorder (MPD), is an extremely rare mental disorder characterized by at least two distinct and relatively enduring identities or dissociated personality states that alternately control a person's behavior.
->
-> [Wikipedia](http://en.wikipedia.org/wiki/Dissociative_identity_disorder)
-
-If it wasn't obvious by now, the reference is the novel, *The Strange Case of Dr. Jeykll and Mr. Hyde*. Jekyll is the platform, Hyde the sister (and original) theme, and now Did the split personality theme (sidebar and content). Is it a stretch? Probably, but I love it.
+Learn more and contribute on [GitHub](https://github.com/poole).
 
 ## Setup
 
 Some fun facts about the setup of this project include:
 
 * Built for [Jekyll](http://jekyllrb.com)
 * Developed on GitHub and hosted for free on [GitHub Pages](https://pages.github.com)
-* Fonts PT Sans (headings) and PT Serif (body), and are served by [Google Web Fonts](http://www.google.com/webfonts)
 * Coded with [Sublime Text 2](http://sublimetext.org), an amazing code editor
 * Designed and developed while listening to music like [Blood Bros Trilogy](https://soundcloud.com/maddecent/sets/blood-bros-series)
 
-Have questions or suggestions? Feel free to [open an issue on GitHub](https://github.com/mdo/did/issues/new) or [ask me on Twitter](https://twitter.com/mdo).
+Have questions or suggestions? Feel free to [open an issue on GitHub](https://github.com/poole/issues/new) or [ask me on Twitter](https://twitter.com/mdo).
 
 Thanks for reading!
diff --git a/public/css/lanyon.css b/public/css/lanyon.css
@@ -9,9 +9,9 @@
  *                               /\___/
  *                               \/__/
  *
- * Lanyon is a Jekyl ltheme built with a featuring a toggleable sidebar drawer
- * for out of sight navigation. It's based on Poole, the Jekyll butler. See the
- * project readme for usage information.
+ * Lanyon is a responsive, mobile first Jekyll theme that features a toggleable
+ * sidebar drawer for out of sight navigation. It's based on Poole, the Jekyll
+ * butler. See the project readme for usage information.
  *
  * Designed, built, and released under MIT license by @mdo.
  *