From c9891a077637e90d0cdc8c34f08474d14861a505 Mon Sep 17 00:00:00 2001 From: Brandon Mathis Date: Sat, 23 Jul 2011 01:36:20 -0400 Subject: [PATCH] updated documentation --- _config.yml | 1 + sass/custom/_styles.scss | 2 ++ source/_includes/navigation.html | 1 + source/docs/blogging/plugins/index.markdown | 12 +++++++ source/docs/index.markdown | 18 +++++------ .../plugins/category-generator/index.markdown | 16 ++++++++-- source/docs/plugins/gist-tag/index.markdown | 1 + source/docs/plugins/index.markdown | 32 +++++++++++-------- .../plugins/octopress-filters/index.markdown | 8 ----- source/docs/plugins/pullquote/index.markdown | 7 ++-- source/docs/setup/index.markdown | 4 ++- 11 files changed, 63 insertions(+), 39 deletions(-) delete mode 100644 source/docs/plugins/octopress-filters/index.markdown diff --git a/_config.yml b/_config.yml index 429f0e9..4ed7afe 100644 --- a/_config.yml +++ b/_config.yml @@ -27,6 +27,7 @@ destination: public plugins: plugins code_dir: downloads/code category_dir: blog/categories +category_title_prefix: "Category: " markdown: rdiscount pygments: false diff --git a/sass/custom/_styles.scss b/sass/custom/_styles.scss index bf1ce48..a7b2bde 100644 --- a/sass/custom/_styles.scss +++ b/sass/custom/_styles.scss @@ -1,3 +1,5 @@ +li { em { color: mix($text-color-light, $text-color); }} + @include font-face("Bebas-Neue", font-files("bebasneue-web.woff", woff, "bebasneue-web.ttf", truetype, "bebasneue-web.svg#BebasNeueRegular", svg), $eot: "bebasneue-web.eot" ); body > header h1 { diff --git a/source/_includes/navigation.html b/source/_includes/navigation.html index b406d96..a99e18d 100644 --- a/source/_includes/navigation.html +++ b/source/_includes/navigation.html @@ -14,4 +14,5 @@
  • Blog
  • Documentation
  • Source
    • +
  • Support
    • diff --git a/source/docs/blogging/plugins/index.markdown b/source/docs/blogging/plugins/index.markdown index fb95a62..7a2eb7e 100644 --- a/source/docs/blogging/plugins/index.markdown +++ b/source/docs/blogging/plugins/index.markdown @@ -9,6 +9,18 @@ footer: false There are [other plugins](/docs/plugins) for octopress, but here's an overview of the ones you'll be likely to use while blogging. This is mainly a description and demo, so be sure to follow the links beneath each section for examples and documentation. +## Excerpt Filter + +When writing a post, you can add an HTML comment `` to split the post for an excerpt. Only the first section of the post, before the comment, +will show up on the blog index. + +This filter is used in `source/_includes/article.html` + +## Image Tag +This plugin makes it easy to insert images in a post, with optional class names, alt and title attributes. + +[Examples & documentation »](/docs/plugins/image-tag/) + ## Block quote {% blockquote @AustinTaylor https://twitter.com/austintaylor/status/73136957617750016 %} diff --git a/source/docs/index.markdown b/source/docs/index.markdown index cc54615..2a68f41 100644 --- a/source/docs/index.markdown +++ b/source/docs/index.markdown @@ -14,19 +14,19 @@ the documentation and if you have trouble, [I'll be happy to help](http://convor ## Getting Started If you're using bundler and rvm, this should be a breeze. -- [Initial setup](/docs/setup) - Get source and install dependencies -- [Basic Configuration](/docs/configuring) - Enable third party services and personalize your blog -- [Deploying Octopress](/docs/deploying) - Simple deploy instructions for Rsync and Github pages +- [Initial setup](/docs/setup) - *get source and install dependencies* +- [Basic Configuration](/docs/configuring) - *enable third party services and personalize your blog* +- [Deploying Octopress](/docs/deploying) - *simple deploy instructions for Rsync and Github pages* ## Using Octopress Your blog should be awesome. This should help. -- [Blogging Basics](/docs/blogging) - How to create blog posts and pages -- [Sharing Code Snippets](/docs/blogging/code) - Share code snippets with ease -- [Syntax Highlighting Test](/docs/blogging/code/test) - Language highlighting tests -- [Blogging With Plugins](/docs/blogging/plugins) - Overview of plugins for blogging -- TODO [Theming & Customization](/docs/theming) - Guide to making changes to your Octopress theme -- TODO [Updating](/docs/updating) - A guide to help you stay up to date +- [Blogging Basics](/docs/blogging) - *how to create blog posts and pages* +- [Sharing Code Snippets](/docs/blogging/code) - *share code snippets with ease* +- [Syntax Highlighting Test](/docs/blogging/code/test) - *language highlighting tests* +- [Blogging With Plugins](/docs/blogging/plugins) - *overview of plugins for blogging* +- TODO [Theming & Customization](/docs/theming) - *guide to making changes to your Octopress theme* +- TODO [Updating](/docs/updating) - *a guide to help you stay up to date* ## Octopress Plugins - Usage & Examples {% render_partial docs/plugins/index.markdown %} diff --git a/source/docs/plugins/category-generator/index.markdown b/source/docs/plugins/category-generator/index.markdown index e2fe611..a62f426 100644 --- a/source/docs/plugins/category-generator/index.markdown +++ b/source/docs/plugins/category-generator/index.markdown @@ -2,7 +2,17 @@ layout: page title: "Category Generator" date: 2011-07-22 09:17 -comments: true -sharing: true -footer: true +sidebar: false +footer: false --- + +The category generator builds category specific archive pages for each category in your blog posts. +The archive pages use the category layout (included with Octopress). In the `_config.yml` you may change +the directory for the category archives if you like and the title for the category pages. + + category_dir: blog/categories + category_title_prefix: "Category: " + +If you visit a category archive for 'open source' the url would be `/blog/categories/open-source/` and the title would be `Category: Open Source`. + +This plugin was originally developed by [Dave Perrett](http://brandontilley.com/2011/01/31/gist-tag-for-jekyll.html) but it has been updated and improved for Octopress. diff --git a/source/docs/plugins/gist-tag/index.markdown b/source/docs/plugins/gist-tag/index.markdown index cd6a8f8..fceac15 100644 --- a/source/docs/plugins/gist-tag/index.markdown +++ b/source/docs/plugins/gist-tag/index.markdown @@ -24,3 +24,4 @@ If you have a gist with multiple files, you can include files one at a time by a {{ "{% gist 1059334 svg_bullets.rb" }} %} {{ "{% gist 1059334 usage.scss" }} %} +This plugin was developed by [Brandon Tilly](http://brandontilley.com/2011/01/31/gist-tag-for-jekyll.html) but I have fixed some bugs and made some improvements to it for Octopress. diff --git a/source/docs/plugins/index.markdown b/source/docs/plugins/index.markdown index 9b72102..686a1de 100644 --- a/source/docs/plugins/index.markdown +++ b/source/docs/plugins/index.markdown @@ -9,17 +9,21 @@ footer: false Octopress ships with the following plugins. Many have been written specially for Octopress, but some have been selected from the Jekyll community with various changes and improvements. -- [Code Block](/docs/plugins/codeblock) - For easy inline code sharing -- [Include Code](/docs/plugins/include-code) - Embed code from your filesystem -- [Gist Tag](/docs/plugins/gist-tag) - Automatically downloads and embeds Github gists -- [Render Partial](/docs/plugins/render-partial) - Insert any file into another post or page -- [Image Tag](/docs/plugins/image-tag) - Easily post images with class names and titles -- [Blockquote](/docs/plugins/blockquote) - Generate beautiful, semantic block quotes -- [Pullquote](/docs/plugins/pullquote) - Generate CSS only pull quotes — no duplicate data, no javascript -- [Custom filters](/docs/plugins/octopress-filters) - Liquid filters built just for Octopress -- [Category Generator](/docs/plugins/category-generator) - Generates archive pages for each blog category -- Sitemap Generator - Generates an SEO friendly sitemap.xml -- Compass Compiler - Forces Jekyll to compile Compass on each load -- Haml Converter - Allows .haml pages to be processed by Jekyll -- Pygments Cache - Caches code snippets to speed up Jekyll processing -- Titlecase - Required by several plugins to automatically generate proper title captalization +- [Code Block](/docs/plugins/codeblock) - *for easy inline code sharing* +- [Include Code](/docs/plugins/include-code) - *embed code from your filesystem* +- [Gist Tag](/docs/plugins/gist-tag) - *automatically downloads and embeds Github gists* +- [Render Partial](/docs/plugins/render-partial) - *insert any file into another post or page* +- [Image Tag](/docs/plugins/image-tag) - *easily post images with class names and titles* +- [Blockquote](/docs/plugins/blockquote) - *generate beautiful, semantic block quotes* +- [Pullquote](/docs/plugins/pullquote) - *generate CSS only pull quotes — no duplicate data, no javascript* +- [Category Generator](/docs/plugins/category-generator) - *generates archive pages for each blog category* + +The following filters are used by Octopress, and are documented as necessary in their source. +- Octopress filters - *liquid filters built just for Octopress* +- Sitemap Generator - *generates an SEO friendly sitemap.xml* +- Compass Compiler - *forces Jekyll to compile Compass on each load* +- Haml Converter - *allows .haml pages to be processed by Jekyll* +- Pygments Cache - *caches code snippets to speed up Jekyll processing* +- Titlecase - *required by several plugins to automatically generate proper title captalization* + +[Octopress plugins source](https://github.com/imathis/octopress/tree/master/plugins) diff --git a/source/docs/plugins/octopress-filters/index.markdown b/source/docs/plugins/octopress-filters/index.markdown deleted file mode 100644 index 40cf359..0000000 --- a/source/docs/plugins/octopress-filters/index.markdown +++ /dev/null @@ -1,8 +0,0 @@ ---- -layout: page -title: "Filters" -date: 2011-07-22 09:17 -comments: true -sharing: true -footer: true ---- diff --git a/source/docs/plugins/pullquote/index.markdown b/source/docs/plugins/pullquote/index.markdown index 9a1c663..bdd533c 100644 --- a/source/docs/plugins/pullquote/index.markdown +++ b/source/docs/plugins/pullquote/index.markdown @@ -2,9 +2,8 @@ layout: page title: "Pullquote" date: 2011-07-22 09:15 -comments: true -sharing: true -footer: true +sidebar: false +footer: false --- Octopress offers a CSS only technique for pull quotes, based on the technique by [Maykel Loomans](http://miekd.com/articles/pull-quotes-with-html5-and-css/). @@ -22,5 +21,5 @@ When writing longform posts, I find it helpful to include pull quotes to help re It is important to note that {" pull quotes are merely visual in presentation and should not appear twice in the text. "} That is why it a CSS only technique for styling pull quotes is preferable. Octopress includes a handy pull quote plugin to make this easy for you. {% endpullquote %} -Inspect the source and you'll see the pulled content appears in the data-pullquote attribute of the paragraph. The pull quote effect is created +**Inspect the source** and you'll see the pulled content appears in the data-pullquote attribute of the paragraph. The pull quote effect is created entirely with CSS, and is supported by all modern browsers as well as IE8 and up. diff --git a/source/docs/setup/index.markdown b/source/docs/setup/index.markdown index 67eb878..6732f4f 100644 --- a/source/docs/setup/index.markdown +++ b/source/docs/setup/index.markdown @@ -6,7 +6,6 @@ sidebar: false footer: false --- - [Create a new repository](https://github.com/repositories/new) for your website then open up a terminal and follow along. If you plan to host your site on [Github Pages](http://pages.github.com) for a user or organization, make sure the repository is named `your_username.github.com` or `your_organization.github.com`. @@ -40,4 +39,7 @@ Install the default Octopress theme, and you should be all set up to begin blogging with Octopress. +**Note:** If you already have a blog, check out [Jekyll's Migration page](https://github.com/mojombo/jekyll/wiki/blog-migrations) to help you get your content formatted for Jekyll blogging. + + [Next, Deploying Octopress »](/docs/deploying)