Skip to content

Commit e3a6bb7

Browse files
committed
fixed readme formatting issues
1 parent 1b48412 commit e3a6bb7

1 file changed

Lines changed: 13 additions & 9 deletions

File tree

README.markdown

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
Octopress gives developers a well designed starting point for a Jekyll blog. It's easy to configure and easy to deploy. Sweet huh?
33

44
#### Octopress comes with
5-
1. A nice easy to configure theme that focuses on readability.
5+
1. A nice, easy to configure theme that focuses on readability.
66
2. Built in support for Twitter, Delicious, and Disqus Comments.
77
3. Rake tasks that make development fast, and deployment easy.
88

@@ -35,13 +35,17 @@ Octopress gives developers a well designed starting point for a Jekyll blog. It'
3535
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.
3636

3737
### Common Rake tasks
38-
**rake preview**: Generates the site, starts the local web server, and opens your browser to show the generated site.
38+
**rake preview**:
39+
Generates the site, starts the local web server, and opens your browser to show the generated site.
3940

40-
**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.
41+
**rake watch**:
42+
Watches the source for changes and regenerates the site every time you save a file. You'll forget your working with a static site.
4143

42-
**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.
44+
**rake deploy**:
45+
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.
4346

44-
**rake stop_serve**: Kills the local web server process.
47+
**rake stop_serve**:
48+
Kills the local web server process.
4549

4650
*There are more but these are the ones you'll use the most. Read the Rakefile if you want to learn more*
4751

@@ -52,20 +56,20 @@ Octopress's stylesheets are written in [SASS](http://sass-lang.com). If you have
5256
### Customizing the default theme
5357
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.
5458

55-
#### Layout
59+
**Layout**
5660
Edit the variables at the top of /stylesheets/_layout.sass to configure the primary structural dimensions, including the header, footer, main content, and sidebar.
5761

58-
#### Typography
62+
**Typography**
5963
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.
6064

6165
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*.
6266

6367
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.
6468

65-
#### Theme
69+
**Theme**
6670
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.
6771

68-
#### Partials
72+
**Partials**
6973
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.
7074

7175
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.

0 commit comments

Comments
 (0)