imathis/octopress

★ 9,254RubyAudience · developerComplexity · 3/5LicenseSetup · moderate

Mindmap

mindmap
  root((Octopress))
    What it does
      Static site generator
      Blog framework
      Built on Jekyll
    Features
      Responsive theme
      Syntax highlighting
      Solarized colors
    Integrations
      Disqus comments
      Google Analytics
      GitHub Gists
    Publishing
      Rake tasks
      GitHub Pages
      Static HTML output

mindmap root((Octopress)) What it does Static site generator Blog framework Built on Jekyll Features Responsive theme Syntax highlighting Solarized colors Integrations Disqus comments Google Analytics GitHub Gists Publishing Rake tasks GitHub Pages Static HTML output

Click or tap to explore — scroll the page freely

Things people build with this

USE CASE 1

Set up a developer blog with syntax-highlighted code snippets pulled from GitHub Gists using rake tasks

USE CASE 2

Deploy a static website to GitHub Pages with a single rake command without managing server infrastructure

USE CASE 3

Embed code samples from local files with automatic Solarized color scheme highlighting in blog posts

USE CASE 4

Connect Google Analytics and Disqus comments to a blog by editing one config file

Tech stack

RubyJekyllRakeHTML5Sass

Getting it running

Difficulty · moderate Time to first run · 30min

Requires Ruby and Bundler, run bundle install to get Jekyll and rake dependencies.

Free to use, modify, and distribute for any purpose, keep the copyright notice and optionally display a Powered by Octopress credit in your site footer.

In plain English

Octopress is a blogging framework built on top of Jekyll, a tool that generates static websites from plain text files. A static website does not run code on a server when someone visits it, instead, it consists of pre-built HTML pages that load quickly and require minimal hosting. Octopress takes the foundational pieces that Jekyll provides and wraps them in a polished setup with a ready-to-use theme and helpful automation. Out of the box, Octopress gives you a clean, responsive theme written in semantic HTML5, meaning it is designed to read well on both desktop and mobile screens. Code publishing is treated as a first-class feature: you can embed syntax-highlighted code directly in blog posts, pulling from GitHub Gists, jsFiddle, or files on your own computer, with a color scheme called Solarized applied automatically. The framework ships with built-in support for several common blogging services. You can connect it to Disqus for comments, Google Analytics for traffic tracking, Pinboard and Delicious for bookmarks, and GitHub Repositories to display your projects. A set of rake tasks, which are scripted commands you run from a terminal, simplifies the process of building and publishing the site so you do not have to handle those steps manually. Note that this repository represents the older 2.x line of Octopress. At the time the README was last updated, version 3.0 was under development in a separate repository. The 2.x version shown here is no longer being actively developed, though the documentation site at Octopress.org covers its usage. The project is open source under the MIT license, meaning you can use, modify, and distribute it freely. The author asks that users display a "Powered by Octopress" credit in their site footer if they want to support the project's visibility.

Copy-paste prompts

Prompt 1

I'm setting up an Octopress 2.x blog. Walk me through the rake tasks to create a new post, build the site locally, and deploy it to GitHub Pages.

Prompt 2

Using Octopress, show me the markup to embed a syntax-highlighted code block pulled from a GitHub Gist in a blog post.

Prompt 3

How do I configure Google Analytics tracking and Disqus comments in an Octopress 2.x site by editing _config.yml?

Prompt 4

What does the Octopress 2.x folder structure look like after setup, and which files do I edit to customize the theme without breaking the rake build?

Open on GitHub → Explain another repo

← imathis on gitmyhub — every repo by this author, as a profile.

Verify against the repo before relying on details.