Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

fixed readme formatting issues

  • Loading branch information...
commit e3a6bb7ca2db89149daeb6776ca8a08db322eec7 1 parent 1b48412
@imathis imathis authored
Showing with 13 additions and 9 deletions.
  1. +13 −9 README.markdown
View
22 README.markdown
@@ -2,7 +2,7 @@
Octopress gives developers a well designed starting point for a Jekyll blog. It's easy to configure and easy to deploy. Sweet huh?
#### Octopress comes with
-1. A nice easy to configure theme that focuses on readability.
+1. A nice, easy to configure theme that focuses on readability.
2. Built in support for Twitter, Delicious, and Disqus Comments.
3. Rake tasks that make development fast, and deployment easy.
@@ -35,13 +35,17 @@ Octopress gives developers a well designed starting point for a Jekyll blog. It'
You should really read over the [Jekyll wiki](http://wiki.github.com/mojombo/jekyll) because most of your work will be using Jekyll. Beyond that Octopress is mostly some rake tasks, HAML, and SASS/Compass that has been meticulously crafted for ease of use and modification.
### Common Rake tasks
-**rake preview**: Generates the site, starts the local web server, and opens your browser to show the generated site.
+**rake preview**:
+Generates the site, starts the local web server, and opens your browser to show the generated site.
-**rake watch**: Watches the source for changes and regenerates the site every time you save a file. You'll forget your working with a static site.
+**rake watch**:
+Watches the source for changes and regenerates the site every time you save a file. You'll forget your working with a static site.
-**rake deploy**: Generates the site and then uses rsync (based on your configurations in the Rakefile) to synchronize with your web host. In order to use rsync you'll need shell access to your host, and you'll probably want to use your public key for authentication.
+**rake deploy**:
+Generates the site and then uses rsync (based on your configurations in the Rakefile) to synchronize with your web host. In order to use rsync you'll need shell access to your host, and you'll probably want to use your public key for authentication.
-**rake stop_serve**: Kills the local web server process.
+**rake stop_serve**:
+Kills the local web server process.
*There are more but these are the ones you'll use the most. Read the Rakefile if you want to learn more*
@@ -52,20 +56,20 @@ Octopress's stylesheets are written in [SASS](http://sass-lang.com). If you have
### Customizing the default theme
The default theme is comprised of Layout, Typography, Theme, and Partials. Octopress also has a library of mixins that act like SASS helpers for styling tasks.
-#### Layout
+**Layout**
Edit the variables at the top of /stylesheets/_layout.sass to configure the primary structural dimensions, including the header, footer, main content, and sidebar.
-#### Typography
+**Typography**
Octopress puts a strong focus on readability and borrows some concepts from the [better web readability project](http://code.google.com/p/better-web-readability-project/). As a result the base font size is 16px. Don't worry though, if you don't like that, you can simply change the variable !base\_font\_size at the top of /stylesheets/_typography.sass and all of the other typographic math (heading sizes, line-heights, margins, etc) will be resized to suit automatically.
If you want to add or modify site-wide typography, this is the file to do it in. If your changes are specific to a small section or feature of your site, you should probably add that under *Partials*.
Octopress ships with a typography test page /test/typography.html that lets you preview the default typographic styles, and see how your changes affect them.
-#### Theme
+**Theme**
Every color used in Octopress is assigned to a variable in _theme.sass, so you can change them to suit your tastes without having to dig through a bunch of files to find the color your looking for. Also the colors variables are grouped by their location in the site layout to make them easier to find.
-#### Partials
+**Partials**
These are the styles for subsections of the site. They're located in /stylesheets/partials and each subsection has it's own file. Here you'll find styles for the sidebar, blog posts, syntax highlighting, and specific page elements that don't belong in the base layout files.
Octopress ships with a syntax highlighting test page /test/syntax.html that lets you preview the default syntax highlighting styles, and see how your changes affect them.
Please sign in to comment.
Something went wrong with that request. Please try again.