octopress 3.0.0.rc.26 → 3.0.0.rc.27

Sign up to get free protection for your applications and to get access to all the features.
Files changed (14) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +33 -26
  3. data/README.md +208 -19
  4. data/lib/octopress.rb +1 -1
  5. data/lib/octopress/docs.rb +2 -2
  6. data/lib/octopress/draft.rb +1 -1
  7. data/lib/octopress/scaffold.rb +30 -5
  8. data/lib/octopress/version.rb +1 -1
  9. data/site/Gemfile +21 -10
  10. data/site/_config.yml +1 -0
  11. data/site/_data/_plugins.yml +6 -3
  12. data/site/index.html +3 -3
  13. metadata +2 -3
  14. data/assets/docs/index.md +0 -221
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 727ee7d51be4119ea57bded0308bd58cb049f6d3
4
- data.tar.gz: 07414b0416d58b6cbcc92d2672433e6b45bb7379
3
+ metadata.gz: c49a09c13d45bf3be7b30759d6284f1de523e94c
4
+ data.tar.gz: 694d1f23b2ae90f5ea05ded02f696c6ef099e8c5
5
5
  SHA512:
6
- metadata.gz: 637af731d6d9020efc0564eea32ea76f7b77c4f20b3652c611bf63d09442cdc297d61a03f92b1a9ba2c9e127a5e1894e85f895b5f8f878a0d1223a19ba5c0438
7
- data.tar.gz: d6ebdda6680265da6d21133aa732bc400c5478c8ab56b18e0cff2d1614a2fcdb122818336f1d7b2e4666b69fc8e1fb7c5e574c47bf0f5a4883a5c518f5e15a91
6
+ metadata.gz: ecbea7b7e07250542ea6de9440307bb5e0ee55a5109212379126425914eb621e3837841ac2200d6ce5a68b146ff61eea566d7dfc397cf848d8a2212bebec7037
7
+ data.tar.gz: 6cfa88e9943682bcd9df10c734432a1b87086b5f7f5127ff7d161c81a47e4ef8655ef9bbb4757afac356dd1c1ff91407ae35d6c65f7cfe279e4e9a9518c666ca
data/CHANGELOG.md CHANGED
@@ -1,107 +1,114 @@
1
1
  # Octopress Changelog
2
2
 
3
- ### 3.0.0 RC26 - 2015-01-02
3
+ ### 3.0.0 RC27 (2015-01-02)
4
4
 
5
- - Added `unpublish` command for converting posts into drafts
5
+ - Minor fix to paths.
6
+ - Improved scaffold command output.
7
+ - Fixed drafts template config.
8
+ - Added config documentation for template file configs.
6
9
 
7
- ### 3.0.0 RC25 - 2015-01-02
10
+ ### 3.0.0 RC26 (2015-01-02)
11
+
12
+ - Added `unpublish` command for converting posts into drafts.
13
+
14
+ ### 3.0.0 RC25 (2015-01-02)
8
15
 
9
16
  - Fixed missing scaffolding.
10
17
 
11
- ### 3.0.0 RC24 - 2015-01-02
18
+ ### 3.0.0 RC24 (2015-01-02)
12
19
 
13
20
  - Absorbed Octopress Docs features.
14
21
 
15
- ### 3.0.0 RC23 - 2014-12-19
22
+ ### 3.0.0 RC23 (2014-12-19)
16
23
 
17
24
  - Fixed issue with site configuration caching
18
25
 
19
- ### 3.0.0 RC22 - 2014-12-13
26
+ ### 3.0.0 RC22 (2014-12-13)
20
27
 
21
28
  - Docs integration improvements.
22
29
  - Refactored and documented Jekyll site methods.
23
30
 
24
- ### 3.0.0 RC21 - 2014-12-12
31
+ ### 3.0.0 RC21 (2014-12-12)
25
32
 
26
33
  - Improved access to Jekyll site instance.
27
34
 
28
- ### 3.0.0 RC20 - 2014-12-11
35
+ ### 3.0.0 RC20 (2014-12-11)
29
36
 
30
37
  - Minor improvements to config management system.
31
38
 
32
- ### 3.0.0 RC19 - 2014-12-09
39
+ ### 3.0.0 RC19 (2014-12-09)
33
40
 
34
41
  - Improvements to configuration management.
35
42
  - Now using _config.yml for configuration instead of _octopress.yml
36
43
 
37
- ### 3.0.0 RC18 - 2014-12-08
44
+ ### 3.0.0 RC18 (2014-12-08)
38
45
 
39
46
  - Loads site plugins before creating new pages, posts and drafts, allowing liquid tag processing in _template files.
40
47
 
41
- ### 3.0.0 RC17 - 2014-12-08
48
+ ### 3.0.0 RC17 (2014-12-08)
42
49
 
43
50
  - Added a configuration tip when adding a new collection page.
44
51
 
45
- ### 3.0.0 RC16 - 2014-11-24
52
+ ### 3.0.0 RC16 (2014-11-24)
46
53
 
47
54
  - Added `integrate` and `isolate` commands.
48
55
  - Removed unnecessary Jekyll pass-through commands (`serve`, `build` and `doctor`).
49
56
 
50
- ### 3.0.0 RC14 - 2014-07-26
57
+ ### 3.0.0 RC14 (2014-07-26)
51
58
 
52
59
  - Simplified configuration management.
53
60
  - Now requiring titlecase gem directly.
54
61
 
55
- ### 3.0.0 RC13 - 2014-07-24
62
+ ### 3.0.0 RC13 (2014-07-24)
56
63
 
57
64
  - Templates are no longer required unless passed as an option.
58
65
  - The default drafts template doesn't have a date anymore.
59
66
  - Now using octopress filters for titlecase.
60
67
 
61
- ### 3.0.0 RC12 - 2014-05-23
68
+ ### 3.0.0 RC12 (2014-05-23)
62
69
 
63
70
  - Change: Default page template no longer includes a date.
64
71
  - Improved date management when publishing a draft.
65
72
 
66
- ### 3.0.0 RC11 - 2014-05-07
73
+ ### 3.0.0 RC11 (2014-05-07)
67
74
 
68
75
  - Replaced Hash extensions with Jekyll utility methods.
69
76
  - Replaced String extension "titlecase" with Octopress utility method.
70
77
 
71
- ### 3.0.0 RC10 - 2014-05-07
78
+ ### 3.0.0 RC10 (2014-05-07)
72
79
 
73
80
  - Now using SafeYAML.load instead of YAML.safe_load [#38](https://github.com/octopress/octopress/issues/38)
74
81
 
75
- ### 3.0.0 RC9 - 2014-05-07
82
+ ### 3.0.0 RC9 (2014-05-07)
76
83
 
77
84
  - Support for Jekyll 2.0
78
85
 
79
- ### 3.0.0 RC8 - 2014-05-02
86
+ ### 3.0.0 RC8 (2014-05-02)
80
87
 
81
88
  - Improved draft date management [#35](https://github.com/octopress/octopress/issues/35)
82
89
 
83
- ### 3.0.0 RC7 - 2014-03-24
90
+ ### 3.0.0 RC7 (2014-03-24)
84
91
 
85
92
  - Fixed Time.parse with `--date` option on new posts and pages.
86
93
  - Bumped Jekyll to 1.5.
87
94
 
88
- ### 3.0.0 RC6 - 2014-03-22
95
+ ### 3.0.0 RC6 (2014-03-22)
89
96
 
90
97
  - Added support for octopress-ink documentation system.
91
98
  - Added a `update_docs` Rake task to update docs from the readme and changelog.
92
99
 
93
- ### 3.0.0 RC5 - 2014-03-21
100
+ ### 3.0.0 RC5 (2014-03-21)
94
101
  - Added octopress-docs to blessed gem list.
95
102
 
96
- ### 3.0.0 RC4 - 2014-03-18
103
+ ### 3.0.0 RC4 (2014-03-18)
97
104
  - Updated mercenary. Fixed issue: #34
98
105
 
99
- ### 3.0.0 RC3 - 2014-03-18
106
+ ### 3.0.0 RC3 (2014-03-18)
100
107
  - `serve --watch` fixed. Fixed issue: #33
101
108
 
102
- ### 3.0.0 RC2 - 2014-03-18
109
+ ### 3.0.0 RC2 (2014-03-18)
103
110
  - `new post` command has new `--dir` option to save new posts in _posts/<DIR>/. Fixed issue #31
104
111
 
105
- ### 3.0.0 RC1 - 2014-03-17
112
+ ### 3.0.0 RC1 (2014-03-17)
106
113
  - Initial release of Octopress CLI
107
114
 
data/README.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  Octopress is an obsessively designed toolkit for writing and deploying Jekyll blogs. Pretty sweet, huh?
4
4
 
5
- <!--[![Gem Version](https://badge.fury.io/rb/octopress.png)](http://badge.fury.io/rb/octopress)-->
5
+ [![Gem Version](https://badge.fury.io/rb/octopress.png)](http://badge.fury.io/rb/octopress)
6
6
  [![Build Status](https://travis-ci.org/octopress/octopress.png?branch=master)](https://travis-ci.org/octopress/octopress)
7
7
 
8
8
  ## Installation
@@ -19,33 +19,222 @@ Or install it yourself as:
19
19
 
20
20
  $ gem install octopress --pre
21
21
 
22
- ## Basic Usage
22
+ ## Octopress Commands
23
23
 
24
- Here are the commands for Octopress.
24
+ Here are the subcommands for Octopress.
25
25
 
26
- | Option | Description |
27
- |:--------------------------------|:----------------------------------------------|
28
- | `octopress init <PATH>` | Adds Octopress scaffolding to your site |
29
- | `octopress new <PATH>` | Like `jekyll new` + `octopress init` |
30
- | `octopress new post <TITLE>` | Add a new post to your site |
31
- | `octopress new page <PATH>` | Add a new page to your site |
32
- | `octopress new draft <TITLE>` | Add a new draft post to your site |
33
- | `octopress publish <PATH>` | Publish a draft from _drafts to _posts |
34
- | `octopress unpublish <POST>` | Convert a post into a draft |
35
- | `octopress isolate <POST>` | Isolate one or more posts for a faster build |
36
- | `octopress integrate` | Restores all posts, reverting isolation. |
26
+ ```
27
+ init <PATH> # Adds Octopress scaffolding to your site
28
+ new <PATH> # Like `jekyll new` + `octopress init`
29
+ new post <TITLE> # Add a new post to your site
30
+ new page <PATH> # Add a new page to your site
31
+ new draft <TITLE> # Add a new draft post to your site
32
+ publish <POST> # Publish a draft from _drafts to _posts
33
+ unpublish <POST> # Search for a post and convert it into a draft
34
+ isolate [POST] # Stash all posts but the one you're workign on for a faster build
35
+ integrate # Restores all posts, doing the opposite of the isolate command
36
+ ```
37
37
 
38
- Run `octopress [command] --help` to learn more about any command and see its options.
38
+ Run `octopress --help` to list sub commands and `octopress <subcommand> --help` to learn more about any subcommand and see its options.
39
39
 
40
- ### Deployment
40
+ ### Init
41
41
 
42
- You can deploy your Octopress or Jekyll blog via git, rsync or Amazon S3. The deployment system ships with the [octopress-deploy][] gem which extends the Octopress CLI with the `deploy` command.
42
+ ```sh
43
+ $ octopress init <PATH> [options]
44
+ ```
43
45
 
44
- [octopress-deploy]: https://github.com/octopress/deploy
46
+ This will copy Octopress's scaffolding into the specified directory. Use the `--force` option to overwrite existing files. The scaffolding is pretty simple:
47
+
48
+ ```
49
+ _templates/
50
+ draft
51
+ post
52
+ page
53
+ ```
54
+
55
+ ### New Post
56
+
57
+ This automates the creation of a new post.
58
+
59
+ ```sh
60
+ $ octopress new post "My Title"
61
+ ```
62
+
63
+ This will create a new file at `_posts/YYYY-MM-DD-my-title.markdown` with the following YAML front-matter already added.
64
+
65
+ ```
66
+ layout: post
67
+ title: "My Title"
68
+ date: YYYY-MM-DDTHH:MM:SS-00:00
69
+ ```
70
+
71
+ #### Command options
72
+
73
+ | Option | Description |
74
+ |:---------------------|:----------------------------------------|
75
+ | `--template PATH` | Use a template from <path> |
76
+ | `--date DATE` | The date for the post. Should be parseable by [Time#parse](http://ruby-doc.org/stdlib-2.1.0/libdoc/time/rdoc/Time.html#method-i-parse) |
77
+ | `--slug SLUG` | Slug for the new post. |
78
+ | `--dir DIR` | Create post at _posts/DIR/. |
79
+ | `--force` | Overwrite existing file. |
80
+
81
+ ### New Page
82
+
83
+ Creating a new page is easy, you can use the default file name extension (.html), pass a specific extension, or end with a `/` to create
84
+ an index.html document.
85
+
86
+ ```
87
+ $ octopress new page some-page # ./some-page.html
88
+ $ octopress new page about.md # ./about.md
89
+ $ octopress new page docs/ # ./docs/index.html
90
+ ```
91
+
92
+ If you are working with collections, you might add a page like this:
93
+
94
+ ```
95
+ $ octopress new page _legal/terms # ./_legal/terms.html
96
+ ```
97
+
98
+ After the page is created, Octopress will tell you how to configure this new collection.
99
+
100
+
101
+ #### Command options
102
+
103
+ | Option | Description |
104
+ |:---------------------|:----------------------------------------|
105
+ | `--template PATH` | Use a template from <path> |
106
+ | `--title TITLE` | The title of the new page |
107
+ | `--date DATE` | The date for the page. Should be parseable by [Time#parse](http://ruby-doc.org/stdlib-2.1.0/libdoc/time/rdoc/Time.html#method-i-parse) |
108
+ | `--force` | Overwrite existing file. |
109
+
110
+ Note: The default page template doesn't expect a date. If you want to add dates
111
+ to your pages, consider adding `date: {{ date }}` to the default template
112
+ `_templates/page`, or create a new template to use for dated pages. Otherwise,
113
+ you will have the `--date` option to add a date to a page.
114
+
115
+ ### New Draft
116
+
117
+ This will create a new post in your `_drafts` directory.
118
+
119
+ ```sh
120
+ $ octopress new draft "My Title"
121
+ ```
122
+
123
+ | Option | Description |
124
+ |:-------------------|:------------------------------------------|
125
+ | `--template PATH` | Use a template from <path> |
126
+ | `--date DATE` | The date for the draft. Should be parseable by [Time#parse](http://ruby-doc.org/stdlib-2.1.0/libdoc/time/rdoc/Time.html#method-i-parse) (defaults to Time.now) |
127
+ | `--slug SLUG` | The slug for the new post. |
128
+ | `--force` | Overwrite exsiting file. |
129
+
130
+ ### Publish a draft
131
+
132
+ Use the `publish` command to publish a draft to the `_posts` folder. This will also rename the file with the proper date format.
133
+
134
+ ```sh
135
+ $ octopress publish _drafts/some-cool-post.md
136
+ $ octopress publish cool
137
+ ```
138
+ In the first example, a draft is published using the path. The publish command can also search for a post by filename. The second command
139
+ would work the same as the first. If other drafts match your search, you will be prompted to select them from a menu. This is often much
140
+ faster than typing out the full path.
141
+
142
+ | Option | Description |
143
+ |:-------------------|:------------------------------------------|
144
+ | `--date DATE` | The date for the post. Should be parseable by [Time#parse](http://ruby-doc.org/stdlib-2.1.0/libdoc/time/rdoc/Time.html#method-i-parse) |
145
+ | `--slug SLUG` | Change the slug for the new post. |
146
+ | `--dir DIR` | Create post at _posts/DIR/. |
147
+ | `--force` | Overwrite existing file. |
148
+
149
+ When publishing a draft, the new post will use the draft's date. Pass the option `--date now` to the publish command to set the new post date from your system clock. As usual, you can pass any compatible date string as well.
150
+
151
+ ### Unpublish a post
152
+
153
+ Use the `unpublish` command to move a post to the `_drafts` directory, renaming the file according to the drafts convention.
154
+
155
+ ```sh
156
+ $ octopress unpublish _posts/2015-01-10-some-post.md
157
+ $ octopress unpublish some post
158
+ ```
159
+
160
+ Just like the publish command, you can either pass a path or a search string to match the file name. If more than one match is found, you
161
+ will be prompted to select from a menu of posts.
162
+
163
+ ### Templates for Posts and pages
164
+
165
+ Octopress post and page templates look like this.
166
+
167
+ ```
168
+ ---
169
+ layout: {{ layout }}
170
+ title: {{ title }}
171
+ ---
172
+ ```
173
+
174
+ Dates get automatically added to a template for posts, and for pages if a --date option is set.
175
+
176
+ You can add to the YAML front matter, add content below and even even use liquid tags and filters from your site's plugins. There are
177
+ a handful of local variables you can use when working with templates.
178
+
179
+ | Variable | Description |
180
+ |:-------------------|:------------------------------------------|
181
+ | `date` | The date (if set) or Time.now.iso8601 |
182
+ | `title` | The title of the page (if set) |
183
+ | `slug` | The title in slug form |
184
+ | `ymd` | The date string, YYYY/MM/DD format |
185
+ | `year` | The date's year |
186
+ | `month` | The date's month, MM |
187
+ | `day` | The date's day, DD |
188
+
189
+ By default Octopress has templates for pages, posts and drafts. You can change them or create new ones for different types of content.
190
+ To create linkposts template, add a file at `_templates/linkpost` and use it with a new post like this:
191
+
192
+ ```sh
193
+ $ octopress new post --template _templates/linkpost
194
+ ```
195
+
196
+ File name extensions are unnecessary since they're just plain text anyway.
197
+
198
+ ## Isolate
199
+
200
+ The `isolate` command will allow you to stash posts in `_posts/_exile` where they will be ignored by Jekyll during the build process.
201
+ Run `octopress integrate` to restore all exiled posts. This can be helpful if you have a very large site and you want to quickly preview a build
202
+ for a single post or page.
203
+
204
+ ```sh
205
+ $ octopress isolate # Move all posts
206
+ $ octopress isolate _posts/2014-10-11-kittens.md # Move post at path
207
+ $ octopress isolate kittens # Move post matching search
208
+ ```
209
+
210
+ In the third example, if multiple posts match the search a prompt will ask you to select a post from a menu.
211
+
212
+ ## Configuration
213
+
214
+ Octopress reads its configurations from `_config.yml`. Here's what the configuration looks like by default.
215
+
216
+ ```yaml
217
+ # Default extension for new posts and pages
218
+ post_ext: markdown
219
+ page_ext: html
220
+
221
+ # Default templates for posts and pages
222
+ # Found in _templates/
223
+ post_layout: post
224
+ page_layout: page
225
+
226
+ # Format titles with titlecase?
227
+ titlecase: true
228
+
229
+ # Change default template file (in _templates/)
230
+ post_template: post
231
+ page_template: page
232
+ draft_template: draft
233
+ ```
45
234
 
46
235
  ## Contributing
47
236
 
48
- 1. Fork it
237
+ 1. Fork it ( https://github.com/octopress/octopress/fork )
49
238
  2. Create your feature branch (`git checkout -b my-new-feature`)
50
239
  3. Commit your changes (`git commit -am 'Add some feature'`)
51
240
  4. Push to the branch (`git push origin my-new-feature`)
data/lib/octopress.rb CHANGED
@@ -76,7 +76,7 @@ module Octopress
76
76
  end
77
77
 
78
78
  def self.gem_dir(dir='')
79
- File.expand_path(File.join(File.dirname(__FILE__), '../', dir))
79
+ File.expand_path(File.join(File.dirname(__FILE__), '..', dir))
80
80
  end
81
81
 
82
82
  def self.require_blessed_gems
data/lib/octopress/docs.rb CHANGED
@@ -248,8 +248,8 @@ module Octopress
248
248
  source = Octopress.gem_dir('local')
249
249
  {
250
250
  'source' => source,
251
- 'destination' => File.join(source, '/_site'),
252
- 'layouts' => File.join(source, '/_layouts'),
251
+ 'destination' => File.join(source, '_site'),
252
+ 'layouts' => File.join(source, '_layouts'),
253
253
  'port' => '4444',
254
254
  'serving' => true,
255
255
  }
data/lib/octopress/draft.rb CHANGED
@@ -11,7 +11,7 @@ module Octopress
11
11
  @options['layout'] = @config['post_layout']
12
12
  @options['dir'] ||= ''
13
13
  @options['extension'] ||= @config['post_ext']
14
- @options['template'] ||= @config['post_template']
14
+ @options['template'] ||= @config['draft_template']
15
15
 
16
16
  if @options['date']
17
17
  @options['date'] = convert_date @options['date']
data/lib/octopress/scaffold.rb CHANGED
@@ -1,3 +1,5 @@
1
+ require 'find'
2
+
1
3
  module Octopress
2
4
  class Scaffold
3
5
  attr_reader :path, :force
@@ -9,19 +11,42 @@ module Octopress
9
11
  end
10
12
 
11
13
  def write
12
- if !@force && (File.exist?(path + '/_templates') ||
13
- File.exist?(path + '/_octopress.yml'))
14
+ if !@force && File.exist?(File.join(path, '_templates'))
14
15
  abort "Some files already exist. Use --force to overwrite."
15
16
  end
16
17
 
17
- FileUtils.cp_r scaffold_path + '/.', path
18
+ FileUtils.cp_r(File.join(scaffold_path, '.'), path)
19
+ puts "Added Octopress scaffold:"
20
+ puts scaffold_file_list.green
21
+ end
18
22
 
19
- puts "Octopress scaffold added to #{path}."
23
+ def local_path
24
+ pwd = File.join(Dir.pwd, '')
25
+ path.sub(pwd, '')
20
26
  end
21
27
 
22
28
  def scaffold_path
23
29
  Octopress.gem_dir('scaffold')
24
30
  end
25
-
31
+
32
+ # Returns a list of
33
+ def scaffold_files
34
+ Find.find(scaffold_path).to_a.reject do |file|
35
+ file == scaffold_path
36
+ end
37
+ end
38
+
39
+ def scaffold_file_list
40
+ scaffold_files.map do |file|
41
+ name = file.sub(File.join(scaffold_path, ''), '')
42
+ name = name.gsub(/[^\/]+\//, ' ')
43
+
44
+ if File.directory?(file)
45
+ name = File.join(name, '')
46
+ end
47
+
48
+ " + " + name
49
+ end.join("\n")
50
+ end
26
51
  end
27
52
  end
data/lib/octopress/version.rb CHANGED
@@ -1,3 +1,3 @@
1
1
  module Octopress
2
- VERSION = "3.0.0.rc.26"
2
+ VERSION = "3.0.0.rc.27"
3
3
  end
data/site/Gemfile CHANGED
@@ -5,23 +5,34 @@ gem "pry-byebug"
5
5
 
6
6
  group :jekyll_plugins do
7
7
  gem "octopress", path: "../"
8
- gem "octopress-ink"#, path: "../../ink"
9
8
  gem "octopress-deploy"#, path: "../../deploy"
10
- gem "octopress-solarized"#, path: "../../solarized"
9
+ gem "octopress-linkblog"#, path: "../../linkblog"
10
+ gem "octopress-feeds"#, path: "../../feeds"
11
11
  gem "octopress-asset-pipeline"#, path: "../../asset-pipeline"
12
+ gem "octopress-minify-html"#, path: "../../minify-html"
13
+ gem "octopress-date-format"#, path: "../../date-format"
14
+ gem "octopress-genesis-theme"#, path: "../../genesis"
15
+ gem "octopress-ink"#, path: "../../ink"
12
16
  gem "octopress-codefence"#, path: "../../codefence"
13
- gem "octopress-codeblock"#, path: "../../codeblock"
14
- gem "octopress-render-code"#, path: "../../render-code"
15
17
  gem "octopress-gist"#, path: "../../gist"
16
- gem "octopress-abort-tag"#, path: "../../abort-tag"
17
- gem "octopress-include-tag"#, path: "../../include-tag"
18
- gem "octopress-render-tag"#, path: "../../render-tag"
19
- gem "octopress-return-tag"#, path: "../../return-tag"
20
- gem "octopress-minify-html"#, path: "../../minify-html"
18
+ gem "octopress-render-code"#, path: "../../render-code"
19
+ gem "octopress-codeblock"#, path: "../../codeblock"
20
+ gem "octopress-solarized"#, path: "../../solarized"
21
+ gem "octopress-debugger"#, path: "../../debugger"
22
+ gem "clash", path: "../../clash"
21
23
  gem "octopress-quote-tag"#, path: "../../quote-tag"
22
24
  gem "octopress-pullquote-tag"#, path: "../../pullquote-tag"
23
25
  gem "octopress-image-tag"#, path: "../../image-tag"
24
26
  gem "octopress-video-tag"#, path: "../../video-tag"
25
- gem "clash", path: "../../clash"
27
+ gem "octopress-include-tag"#, path: "../../include-tag"
28
+ gem "octopress-render-tag"#, path: "../../render-tag"
29
+ gem "octopress-wrap-tag"#, path: "../../wrap-tag"
30
+ gem "octopress-assign-tag"#, path: "../../assign-tag" *
31
+ gem "octopress-capture-tag"#, path: "../../capture-tag" *
32
+ gem "octopress-return-tag"#, path: "../../return-tag"
33
+ gem "octopress-comment-tag"#, path: "../../comment-tag" *
34
+ gem "octopress-content-for"#, path: "../../content-for"
35
+ gem "octopress-markdown-tag"# path: "../../markdown-tag"
36
+ gem "octopress-abort-tag"#, path: "../../abort-tag"
26
37
  end
27
38
 
data/site/_config.yml CHANGED
@@ -1,3 +1,4 @@
1
+ url: http://octopress.org
1
2
  markdown: redcarpet
2
3
  exclude:
3
4
  - Gemfile
data/site/_data/_plugins.yml CHANGED
@@ -17,21 +17,24 @@ developer_tools:
17
17
  - octopress-render-code
18
18
  - octopress-codeblock
19
19
  - octopress-solarized
20
+ - octopress-filters
21
+ - octopress-debugger
20
22
  - clash
21
23
 
22
24
  liquid_plugins:
23
25
  - octopress-quote-tag
26
+ - octopress-filter-tag
27
+ - octopress-pullquote-tag
24
28
  - octopress-image-tag
25
29
  - octopress-video-tag
26
30
  - octopress-include-tag
27
31
  - octopress-render-tag
28
32
  - octopress-wrap-tag
29
- - octopress-abort-tag
30
- - octopress-abort-tag
31
33
  - octopress-assign-tag
32
34
  - octopress-capture-tag
33
35
  - octopress-filter-tag
34
36
  - octopress-return-tag
35
37
  - octopress-comment-tag
36
38
  - octopress-content-for
37
- - octopress-markdown-block
39
+ - octopress-markdown-tag
40
+ - octopress-abort-tag
data/site/index.html CHANGED
@@ -1,13 +1,13 @@
1
1
  ---
2
- layout: default
2
+ layout: theme:page
3
3
  ---
4
4
 
5
- {% for plugin in plugin_docs %}
6
5
  <ul class='plugin'>
6
+ {% for plugin in plugin_docs %}
7
7
  <li>
8
8
  <a href="/{{ plugin[1].url }}">{{ plugin[1].name }}</a>{% if plugin[1].description %} - {{ plugin[1].description }}{% endif %}
9
9
  {% assign source = plugin[1].source_url %}
10
10
  {% if source %} - {{ source | docs_source_url }}{% endif %}
11
11
  </li>
12
- </ul>
13
12
  {% endfor %}
13
+ </ul>
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: octopress
3
3
  version: !ruby/object:Gem::Version
4
- version: 3.0.0.rc.26
4
+ version: 3.0.0.rc.27
5
5
  platform: ruby
6
6
  authors:
7
7
  - Brandon Mathis
@@ -9,7 +9,7 @@ authors:
9
9
  autorequire:
10
10
  bindir: bin
11
11
  cert_chain: []
12
- date: 2015-01-11 00:00:00.000000000 Z
12
+ date: 2015-01-15 00:00:00.000000000 Z
13
13
  dependencies:
14
14
  - !ruby/object:Gem::Dependency
15
15
  name: mercenary
@@ -179,7 +179,6 @@ files:
179
179
  - LICENSE
180
180
  - README.md
181
181
  - assets/docs/docs.md
182
- - assets/docs/index.md
183
182
  - bin/octopress
184
183
  - lib/octopress.rb
185
184
  - lib/octopress/command.rb
data/assets/docs/index.md DELETED
@@ -1,221 +0,0 @@
1
- ---
2
- title: Using Octopress
3
- ---
4
-
5
- {% include install.html %}
6
-
7
- ## Octopress Commands
8
-
9
- Here are the subcommands for Octopress.
10
-
11
- ```
12
- init <PATH> # Adds Octopress scaffolding to your site
13
- new <PATH> # Like `jekyll new` + `octopress init`
14
- new post <TITLE> # Add a new post to your site
15
- new page <PATH> # Add a new page to your site
16
- new draft <TITLE> # Add a new draft post to your site
17
- publish <POST> # Publish a draft from _drafts to _posts
18
- unpublish <POST> # Search for a post and convert it into a draft
19
- isolate [POST] # Stash all posts but the one you're workign on for a faster build
20
- integrate # Restores all posts, doing the opposite of the isolate command
21
- ```
22
-
23
- Run `octopress --help` to list sub commands and `octopress <subcommand> --help` to learn more about any subcommand and see its options.
24
-
25
- ### Init
26
-
27
- ```sh
28
- $ octopress init <PATH> [options]
29
- ```
30
-
31
- This will copy Octopress's scaffolding into the specified directory. Use the `--force` option to overwrite existing files. The scaffolding is pretty simple:
32
-
33
- ```
34
- _templates/
35
- draft
36
- post
37
- page
38
- ```
39
-
40
- ### New Post
41
-
42
- This automates the creation of a new post.
43
-
44
- ```sh
45
- $ octopress new post "My Title"
46
- ```
47
-
48
- This will create a new file at `_posts/YYYY-MM-DD-my-title.markdown` with the following YAML front-matter already added.
49
-
50
- ```
51
- layout: post
52
- title: "My Title"
53
- date: YYYY-MM-DDTHH:MM:SS-00:00
54
- ```
55
-
56
- #### Command options
57
-
58
- | Option | Description |
59
- |:---------------------|:----------------------------------------|
60
- | `--template PATH` | Use a template from <path> |
61
- | `--date DATE` | The date for the post. Should be parseable by [Time#parse](http://ruby-doc.org/stdlib-2.1.0/libdoc/time/rdoc/Time.html#method-i-parse) |
62
- | `--slug SLUG` | Slug for the new post. |
63
- | `--dir DIR` | Create post at _posts/DIR/. |
64
- | `--force` | Overwrite existing file. |
65
-
66
- ### New Page
67
-
68
- Creating a new page is easy, you can use the default file name extension (.html), pass a specific extension, or end with a `/` to create
69
- an index.html document.
70
-
71
- ```
72
- $ octopress new page some-page # ./some-page.html
73
- $ octopress new page about.md # ./about.md
74
- $ octopress new page docs/ # ./docs/index.html
75
- ```
76
-
77
- If you are working with collections, you might add a page like this:
78
-
79
- ```
80
- $ octopress new page _legal/terms # ./_legal/terms.html
81
- ```
82
-
83
- After the page is created, Octopress will tell you how to configure this new collection.
84
-
85
-
86
- #### Command options
87
-
88
- | Option | Description |
89
- |:---------------------|:----------------------------------------|
90
- | `--template PATH` | Use a template from <path> |
91
- | `--title TITLE` | The title of the new page |
92
- | `--date DATE` | The date for the page. Should be parseable by [Time#parse](http://ruby-doc.org/stdlib-2.1.0/libdoc/time/rdoc/Time.html#method-i-parse) |
93
- | `--force` | Overwrite existing file. |
94
-
95
- Note: The default page template doesn't expect a date. If you want to add dates
96
- to your pages, consider adding `date: {{ date }}` to the default template
97
- `_templates/page`, or create a new template to use for dated pages. Otherwise,
98
- you will have the `--date` option to add a date to a page.
99
-
100
- ### New Draft
101
-
102
- This will create a new post in your `_drafts` directory.
103
-
104
- ```sh
105
- $ octopress new draft "My Title"
106
- ```
107
-
108
- | Option | Description |
109
- |:-------------------|:------------------------------------------|
110
- | `--template PATH` | Use a template from <path> |
111
- | `--date DATE` | The date for the draft. Should be parseable by [Time#parse](http://ruby-doc.org/stdlib-2.1.0/libdoc/time/rdoc/Time.html#method-i-parse) (defaults to Time.now) |
112
- | `--slug SLUG` | The slug for the new post. |
113
- | `--force` | Overwrite exsiting file. |
114
-
115
- ### Publish a draft
116
-
117
- Use the `publish` command to publish a draft to the `_posts` folder. This will also rename the file with the proper date format.
118
-
119
- ```sh
120
- $ octopress publish _drafts/some-cool-post.md
121
- $ octopress publish cool
122
- ```
123
- In the first example, a draft is published using the path. The publish command can also search for a post by filename. The second command
124
- would work the same as the first. If other drafts match your search, you will be prompted to select them from a menu. This is often much
125
- faster than typing out the full path.
126
-
127
- | Option | Description |
128
- |:-------------------|:------------------------------------------|
129
- | `--date DATE` | The date for the post. Should be parseable by [Time#parse](http://ruby-doc.org/stdlib-2.1.0/libdoc/time/rdoc/Time.html#method-i-parse) |
130
- | `--slug SLUG` | Change the slug for the new post. |
131
- | `--dir DIR` | Create post at _posts/DIR/. |
132
- | `--force` | Overwrite existing file. |
133
-
134
- When publishing a draft, the new post will use the draft's date. Pass the option `--date now` to the publish command to set the new post date from your system clock. As usual, you can pass any compatible date string as well.
135
-
136
- ### Unpublish a post
137
-
138
- Use the `unpublish` command to move a post to the `_drafts` directory, renaming the file according to the drafts convention.
139
-
140
- ```sh
141
- $ octopress unpublish _posts/2015-01-10-some-post.md
142
- $ octopress unpublish some post
143
- ```
144
-
145
- Just like the publish command, you can either pass a path or a search string to match the file name. If more than one match is found, you
146
- will be prompted to select from a menu of posts.
147
-
148
- ### Templates for Posts and pages
149
-
150
- Octopress post and page templates look like this.
151
-
152
- ```
153
- ---
154
- layout: {{ layout }}
155
- title: {{ title }}
156
- ---
157
- ```
158
-
159
- Dates get automatically added to a template for posts, and for pages if a --date option is set.
160
-
161
- You can add to the YAML front matter, add content below and even even use liquid tags and filters from your site's plugins. There are
162
- a handful of local variables you can use when working with templates.
163
-
164
- | Variable | Description |
165
- |:-------------------|:------------------------------------------|
166
- | `date` | The date (if set) or Time.now.iso8601 |
167
- | `title` | The title of the page (if set) |
168
- | `slug` | The title in slug form |
169
- | `ymd` | The date string, YYYY/MM/DD format |
170
- | `year` | The date's year |
171
- | `month` | The date's month, MM |
172
- | `day` | The date's day, DD |
173
-
174
- By default Octopress has templates for pages, posts and drafts. You can change them or create new ones for different types of content.
175
- To create linkposts template, add a file at `_templates/linkpost` and use it with a new post like this:
176
-
177
- ```sh
178
- $ octopress new post --template _templates/linkpost
179
- ```
180
-
181
- File name extensions are unnecessary since they're just plain text anyway.
182
-
183
- ## Isolate
184
-
185
- The `isolate` command will allow you to stash posts in `_posts/_exile` where they will be ignored by Jekyll during the build process.
186
- Run `octopress integrate` to restore all exiled posts. This can be helpful if you have a very large site and you want to quickly preview a build
187
- for a single post or page.
188
-
189
- ```sh
190
- $ octopress isolate # Move all posts
191
- $ octopress isolate _posts/2014-10-11-kittens.md # Move post at path
192
- $ octopress isolate kittens # Move post matching search
193
- ```
194
-
195
- In the third example, if multiple posts match the search a prompt will ask you to select a post from a menu.
196
-
197
- ## Configuration
198
-
199
- Octopress reads its configurations from `_config.yml`. Here's what the configuration looks like by default.
200
-
201
- ```yaml
202
- # Default extension for new posts and pages
203
- post_ext: markdown
204
- page_ext: html
205
-
206
- # Default templates for posts and pages
207
- # Found in _templates/
208
- post_layout: post
209
- page_layout: page
210
-
211
- # Format titles with titlecase?
212
- titlecase: true
213
- ```
214
-
215
- ## Contributing
216
-
217
- 1. Fork it ( https://github.com/octopress/octopress/fork )
218
- 2. Create your feature branch (`git checkout -b my-new-feature`)
219
- 3. Commit your changes (`git commit -am 'Add some feature'`)
220
- 4. Push to the branch (`git push origin my-new-feature`)
221
- 5. Create new Pull Request