updated docs index and added docs for syntax highlighting code

This commit is contained in:
Brandon Mathis 2011-07-21 16:25:13 -04:00
parent aa127a1d0e
commit 76380229c2
2 changed files with 17 additions and 7 deletions

View File

@ -5,18 +5,28 @@ date: 2011-07-19 18:10
sidebar: false sidebar: false
footer: false footer: false
--- ---
[« Previous, Blogging Basics](/docs/blogging)
Sharing code is important, and blogging about it should be easy and beautiful. Sharing code is important, and blogging about it should be easy and beautiful.
That's why Octopress is packed with features to make blogging your code a breeze. That's why Octopress is packed with features to make blogging your code a breeze.
Though Jekyll comes with support for [Pygments syntax highlighting](http://pygments.org), Though Jekyll comes with support for [Pygments syntax highlighting](http://pygments.org),
Octopress makes it way better. Here's how. Octopress makes it way better. Here's how.
- A Sass port of [Solarized syntax highlighting](http://ethanschoonover.com/solarized) created specifically for Octopress - A Sass port of [Solarized syntax highlighting](http://ethanschoonover.com/solarized) created specifically for Octopress.
- Gist code embedding - by [Brandon Tilly](https://gist.github.com/1027674) - Gist code embedding - by [Brandon Tilly](https://gist.github.com/1027674).
- Insert code snippets from your filesystem with a download link. - Insert code snippets from your filesystem with a download link.
- Easy inline code blocks with `<figure>` and `<figcaption>` and optional download links. - Easy inline code blocks with `<figure>` and `<figcaption>` and optional download links.
- Pygments caching - a [Jekyll community plugin](https://github.com/rsim/blog.rayapps.com/blob/master/_plugins/pygments_cache_patch.rb) - Pygments caching - a [Jekyll community plugin](https://github.com/rsim/blog.rayapps.com/blob/master/_plugins/pygments_cache_patch.rb).
- Table based line numbers added with javascript - Table based line numbers added with javascript.
## Solarized Highlighting
[Solarized](http://ethanschoonover.com/solarized) has a beautiful syntax highlighting color scheme, but reproducing it requires a highly sophisticated highlighting engine.
[Pygments](http://pygments.org) (the highlighter Jekyll uses) processes code snippets into styleable HTML, but it isn't nearly as powerful as the highlighting engine in Vim for example.
In order to port Solarized theme to octopress, I processed its [test files](https://github.com/altercation/solarized/tree/master/utils/tests) with Pygments and styled the output with Sass while comparing
them to the Vim rendered versions.
Check out the [test page](/docs/blogging/code/test) to see the results.
## Gist Code embedding ## Gist Code embedding
All you need is the gist's id and you can easily embed it in your page. This actually downloads a cache of the gist and embeds it in a `<noscript>` tag for RSS All you need is the gist's id and you can easily embed it in your page. This actually downloads a cache of the gist and embeds it in a `<noscript>` tag for RSS

View File

@ -17,14 +17,14 @@ Jekyll at its core is a text transformation engine. The concept behind the syste
- [Initial setup](/docs/setup) - [Initial setup](/docs/setup)
- [Deploying Octopress](/docs/deploying) - [Deploying Octopress](/docs/deploying)
- [Basic Configuration](/docs/configuring) - [Basic Configuration](/docs/configuring)
- [Updating](/docs/updating)
## Using Octopress ## Using Octopress
- [Blogging Basics](/docs/blogging) - [Blogging Basics](/docs/blogging)
- [Sharing Code Snippets](/docs/blogging/code) - [Sharing Code Snippets](/docs/blogging/code)
- [Syntax Highlighting Test](/docs/blogging/code/test) - [Syntax Highlighting Test](/docs/blogging/code/test)
- [Blogging With Plugins](/docs/blogging/plugins) - TODO [Blogging With Plugins](/docs/blogging/plugins)
- [Theming & Customization](/docs/theming) - TODO [Theming & Customization](/docs/theming)
- TODO [Updating](/docs/updating)
## Octopress Plugins - Usage & Examples ## Octopress Plugins - Usage & Examples
- Code Block - Code Block