codetrail / octofound Goto Github PK

Welcome to OctoFound! OctoFound is a responsive and highly customizable Foundation-5 theme for Octopress. Click here for a live demo.

• Completely responsive: adapts to any screen size, from ginormous to mobile.
• All of Foundation's SASS and Javascript components are included. Browse Foundation's docs to learn about what these components enable you to do.
• SASS files that are highly documented and easy-to-edit: _settings.scss & screen.scss
• No-sidebar, left-sidebar, and right-sidebar page templates. To use these different layouts, open your_page_or_post.markdown and add the line sidebar: false to hide the sidebar, or sidebar_left: true to make the sidebar display on the left. The sidebar displays on the right by default.
• Sticky navigation bar: to make the navigation bar stick to the top of the page, add the line fixed_navigation: true to your _config.yml file.
• Optional subtitles on pages: in your_page.markdown, put the line subtitle: Your Subtitle Here in the header to give that page a subtitle.
• Font Awesome 4.0.3: click here to browse the amazing icons at your fingertips.

1. Install Foundation 5 & dependencies using these commands:
   • $ [sudo] npm install -g bower grunt-cli
   • $ gem install foundation
   If you have an older version of Foundation already, you may need to uninstall it completely before re-installing the latest version (note that the name of the gem changed between versions 4 and 5).
2. Add the following lines to your config.rb file:
   • add_import_path "bower_components/foundation/scss"
   • javascripts_dir = "source/js"

   </li>
   <li>Install the theme using these commands:
   	<ul>
   		<li><code>$ cd your_octopress_root</code></li>
   		<li><code>$ git clone https://github.com/annejohnson/octofound .themes/octofound</code></li>
   		<li><code>$ rake install['octofound']</code></li>
   		<li><code>$ rake generate</code></li>
   	</ul>
   </li>
   <li>Verify that <code>bower_components</code>, its contents, and <code>bower.json</code> got added to your root directory. If they didn't, you will need to add theme manually.</li>
   <li>If you see any gem version errors, try updating your Gemfiles to reflect updates you made while installing Foundation, and/or run your rake commands with <code>bundle exec</code>. If there are any Foundation errors, try adding Foundation to your Gemfiles.</li>
   <li>Change the home page, and change or delete the no-sidebar, left-sidebar, right-sidebar, and example-formatting pages. 
   	<ul><li>Update <strong>_includes/custom/navigation.html</strong> to reflect these changes. Remember to update not just the link URLs and text, but also the conditionals in the list elements (which are responsible for adding the "active" class).</li></ul>
   </li>