octopress-docs 0.0.11 → 0.0.12
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +14 -11
- data/lib/octopress-docs/command.rb +23 -57
- data/lib/octopress-docs/doc.rb +13 -10
- data/lib/octopress-docs/hooks.rb +1 -6
- data/lib/octopress-docs/jekyll/convertible.rb +31 -0
- data/lib/octopress-docs/{page.rb → jekyll/page.rb} +2 -6
- data/lib/octopress-docs/version.rb +1 -1
- data/lib/octopress-docs.rb +94 -48
- metadata +7 -16
- data/docs/Gemfile +0 -7
- data/docs/Gemfile.lock +0 -103
- data/docs/_config.yml +0 -5
- data/docs/_includes/nav.html +0 -8
- data/docs/_layouts/default.html +0 -10
- data/docs/_layouts/docs.html +0 -15
- data/docs/_layouts/docs_index.html +0 -7
- data/docs/_sass/_solarized.scss +0 -1
- data/docs/index.html +0 -13
- data/docs/stylesheets/site.scss +0 -3
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: d0f898fa67588ef596b6526c6d22bc2397e1033d
|
4
|
+
data.tar.gz: 9a73b42f854a79cbf71b8a7a1a33bab4b23d48f1
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: fa67c8cef9ea239bf0e738acbd932c68eebfeded8f791b9f7ed331d1e4bc0714c6c4899036d5a0cea80ed4d9f2f81a7661d958b0e1f99edc4c35e414f695b04f
|
7
|
+
data.tar.gz: f713820383dd454d48901faa9dacfbf3427703d3be649b604f32cda754c6214d7470bce783325860fc401521d27b97d42de88072c3231fb26a7c9c9a90cc48c5
|
data/README.md
CHANGED
@@ -4,21 +4,24 @@ If you have the Octopress gem installed, run `$ octopress docs` from the root of
|
|
4
4
|
|
5
5
|
## Adding docs to your plugin
|
6
6
|
|
7
|
-
|
8
|
-
|
7
|
+
If your plugin is built on Octopress Ink, these documentation pages are added automatically. If not, use
|
8
|
+
the code below to automatically add your plugin's Readme, Changelog and any pages in your gem path under `assets/docs`.
|
9
9
|
|
10
10
|
```ruby
|
11
|
-
|
12
|
-
Octopress::Docs.add({
|
13
|
-
|
14
|
-
|
15
|
-
|
16
|
-
|
17
|
-
|
18
|
-
|
19
|
-
})
|
11
|
+
if defined? Octopress::Docs
|
12
|
+
Octopress::Docs.add({
|
13
|
+
name: "Your Plugin",
|
14
|
+
description: "This plugin causes awesomeness",
|
15
|
+
path: File.expand_path(File.join(File.dirname(__FILE__), "../")), # gem root
|
16
|
+
slug: "your-plugin", # optional
|
17
|
+
source_url: "https://github.com/some/project", # optional
|
18
|
+
website: "http://example.com", # optional
|
19
|
+
})
|
20
|
+
end
|
20
21
|
```
|
21
22
|
|
23
|
+
It's a bit odd, but the `if defined? Octopress::Docs` allows you to register doc pages if possible, without having to add the octopress-docs gem as a dependency.
|
24
|
+
|
22
25
|
## Contributing
|
23
26
|
|
24
27
|
1. Fork it
|
@@ -19,75 +19,41 @@ module Octopress
|
|
19
19
|
end
|
20
20
|
|
21
21
|
def self.serve_docs(options)
|
22
|
+
# Tell the world, we're serving the docs site
|
23
|
+
#
|
24
|
+
ENV['OCTOPRESS_DOCS'] = 'true'
|
25
|
+
|
22
26
|
# Activate dependencies for serving docs.
|
23
|
-
|
27
|
+
#
|
28
|
+
require "octopress-docs/jekyll/convertible"
|
29
|
+
require "octopress-docs/jekyll/page"
|
30
|
+
require "octopress-docs/liquid_filters"
|
24
31
|
require "octopress-hooks"
|
25
|
-
require "octopress-docs/page"
|
26
32
|
require "octopress-docs/doc"
|
27
33
|
require "octopress-docs/hooks"
|
28
|
-
require "octopress-docs/liquid_filters"
|
29
34
|
|
30
|
-
ENV['OCTOPRESS_DOCS'] = true
|
31
|
-
options = init_octopress_docs(options)
|
32
|
-
options["port"] ||= '4444'
|
33
|
-
options["serving"] = true
|
34
|
-
options = Jekyll.configuration Jekyll::Utils.symbolize_hash_keys(options)
|
35
|
-
Jekyll::Commands::Build.process(options)
|
36
|
-
Jekyll::Commands::Serve.process(options)
|
37
|
-
end
|
38
|
-
|
39
|
-
def self.init_octopress_docs(options)
|
40
|
-
require_plugins
|
41
|
-
options['source'] = site_dir
|
42
|
-
options['destination'] = File.join(site_dir, '_site')
|
43
|
-
options
|
44
|
-
end
|
45
|
-
|
46
|
-
def self.init_jekyll_docs(options)
|
47
|
-
options.delete('jekyll')
|
48
35
|
|
49
|
-
#
|
36
|
+
# Look at the local site and require all of its plugins
|
37
|
+
# Ensuring their documentation is loaded into the docs site
|
50
38
|
#
|
51
|
-
|
52
|
-
|
53
|
-
|
54
|
-
options['source'] = "#{gem_path}/site",
|
55
|
-
options['destination'] = "#{gem_path}/site/_site"
|
56
|
-
options
|
57
|
-
end
|
58
|
-
|
59
|
-
def self.site_dir
|
60
|
-
Docs.gem_dir('docs')
|
61
|
-
end
|
62
|
-
|
63
|
-
def self.require_plugins
|
64
|
-
config = Octopress::Configuration.jekyll_config
|
39
|
+
site = Octopress.read_site({'config'=>options['config']})
|
40
|
+
site.plugin_manager.conscientious_require
|
65
41
|
|
66
|
-
|
67
|
-
|
68
|
-
|
42
|
+
# Require escape code last to set Octopress hook priority.
|
43
|
+
#
|
44
|
+
require "octopress-escape-code"
|
69
45
|
|
70
|
-
|
71
|
-
plugins_path.each do |plugins|
|
72
|
-
Dir[File.join(plugins, "**", "*.rb")].sort.each do |f|
|
73
|
-
require f
|
74
|
-
end
|
75
|
-
end
|
76
|
-
end
|
46
|
+
options = Docs.site.config.merge(options)
|
77
47
|
|
48
|
+
Jekyll.logger.log_level = :error
|
49
|
+
Jekyll::Commands::Build.process(options)
|
50
|
+
url = "http://#{options['host']}:#{options['port']}"
|
51
|
+
puts "Serving Docs site: #{url}"
|
52
|
+
puts " press ctrl-c to stop."
|
53
|
+
Jekyll::Commands::Serve.process(options)
|
54
|
+
Jekyll.logger.log_level = :info
|
78
55
|
end
|
79
56
|
|
80
|
-
# Returns an Array of plugin search paths
|
81
|
-
def self.plugins_path
|
82
|
-
config = Octopress::Configuration.jekyll_config
|
83
|
-
plugins = config['plugins']
|
84
|
-
if (plugins == Jekyll::Configuration::DEFAULTS['plugins'])
|
85
|
-
[Jekyll.sanitized_path(config['source'], plugins)]
|
86
|
-
else
|
87
|
-
Array(plugins).map { |d| File.expand_path(d) }
|
88
|
-
end
|
89
|
-
end
|
90
|
-
|
91
57
|
end
|
92
58
|
end
|
93
59
|
end
|
data/lib/octopress-docs/doc.rb
CHANGED
@@ -1,11 +1,11 @@
|
|
1
1
|
module Octopress
|
2
2
|
module Docs
|
3
3
|
class Doc
|
4
|
-
attr_reader :filename, :plugin_name, :base_url, :plugin_type, :description, :source_url
|
4
|
+
attr_reader :filename, :plugin_name, :plugin_slug, :base_url, :plugin_type, :description, :source_url
|
5
5
|
|
6
6
|
def initialize(options={})
|
7
7
|
@file = options[:file]
|
8
|
-
@
|
8
|
+
@path = options[:path] ||= '.'
|
9
9
|
@file_dir = File.dirname(@file)
|
10
10
|
@plugin_name = options[:name]
|
11
11
|
@plugin_slug = options[:slug]
|
@@ -36,14 +36,17 @@ module Octopress
|
|
36
36
|
|
37
37
|
def page
|
38
38
|
return @page if @page
|
39
|
-
@page = Octopress::Docs::Page.new(Octopress.site, @
|
39
|
+
@page = Octopress::Docs::Page.new(Octopress.site, @path, page_dir, file, {'path'=>@base_url})
|
40
40
|
@page.data['layout'] = 'docs'
|
41
|
+
@page.data['escape_code'] = true
|
42
|
+
|
41
43
|
@page.data['plugin'] = {
|
42
|
-
'name'
|
43
|
-
'slug'
|
44
|
-
'
|
45
|
-
'source_url'
|
46
|
-
'description' => @description
|
44
|
+
'name' => @plugin_name,
|
45
|
+
'slug' => @plugin_slug,
|
46
|
+
'type' => @plugin_type,
|
47
|
+
'source_url' => @source_url,
|
48
|
+
'description' => @description,
|
49
|
+
'url' => @base_url
|
47
50
|
}
|
48
51
|
|
49
52
|
@page.data['dir'] = doc_dir
|
@@ -59,7 +62,7 @@ module Octopress
|
|
59
62
|
end
|
60
63
|
|
61
64
|
def read
|
62
|
-
File.open(File.join(@
|
65
|
+
File.open(File.join(@path, @file)).read
|
63
66
|
end
|
64
67
|
|
65
68
|
def plugin_slug
|
@@ -71,7 +74,7 @@ module Octopress
|
|
71
74
|
end
|
72
75
|
|
73
76
|
def doc_dir
|
74
|
-
File.join(@
|
77
|
+
File.join(@path, page_dir, File.dirname(@file))
|
75
78
|
end
|
76
79
|
|
77
80
|
def comment_yaml(content)
|
data/lib/octopress-docs/hooks.rb
CHANGED
@@ -2,13 +2,8 @@ module Octopress
|
|
2
2
|
module Docs
|
3
3
|
class DocsSiteHook < Octopress::Hooks::Site
|
4
4
|
def post_read(site)
|
5
|
-
if ENV['OCTOPRESS_DOCS'] && Octopress.site.nil?
|
6
|
-
Octopress.site = site
|
7
|
-
end
|
8
|
-
end
|
9
|
-
|
10
|
-
def pre_render(site)
|
11
5
|
if ENV['OCTOPRESS_DOCS']
|
6
|
+
Octopress.site = site
|
12
7
|
site.pages.concat Octopress::Docs.pages
|
13
8
|
end
|
14
9
|
end
|
@@ -0,0 +1,31 @@
|
|
1
|
+
module Octopress
|
2
|
+
module Docs
|
3
|
+
module Convertible
|
4
|
+
include Jekyll::Convertible
|
5
|
+
|
6
|
+
# Read the YAML frontmatter.
|
7
|
+
#
|
8
|
+
# base - The String path to the dir containing the file.
|
9
|
+
# name - The String filename of the file.
|
10
|
+
# opts - optional parameter to File.read, default at site configs
|
11
|
+
#
|
12
|
+
# Returns nothing.
|
13
|
+
def read_yaml(base, name, opts = {})
|
14
|
+
begin
|
15
|
+
self.content = File.read(File.join(base, name),
|
16
|
+
merged_file_read_opts(opts))
|
17
|
+
if content =~ /\A(---\s*\n.*?\n?)^((---|\.\.\.)\s*$\n?)/m
|
18
|
+
self.content = $POSTMATCH
|
19
|
+
self.data = SafeYAML.load($1)
|
20
|
+
end
|
21
|
+
rescue SyntaxError => e
|
22
|
+
Jekyll.logger.warn "YAML Exception reading #{File.join(base, name)}: #{e.message}"
|
23
|
+
rescue Exception => e
|
24
|
+
Jekyll.logger.warn "Error reading file #{File.join(base, name)}: #{e.message}"
|
25
|
+
end
|
26
|
+
|
27
|
+
self.data ||= {}
|
28
|
+
end
|
29
|
+
end
|
30
|
+
end
|
31
|
+
end
|
@@ -1,7 +1,7 @@
|
|
1
1
|
module Octopress
|
2
2
|
module Docs
|
3
3
|
class Page < Jekyll::Page
|
4
|
-
include
|
4
|
+
include Docs::Convertible
|
5
5
|
|
6
6
|
# Purpose: Configs can override a page's permalink
|
7
7
|
#
|
@@ -16,10 +16,6 @@ module Octopress
|
|
16
16
|
post_init if respond_to?(:post_init)
|
17
17
|
end
|
18
18
|
|
19
|
-
def hooks
|
20
|
-
Octopress.site.page_hooks
|
21
|
-
end
|
22
|
-
|
23
19
|
def destination(dest)
|
24
20
|
unless @dest
|
25
21
|
if @config['path']
|
@@ -31,7 +27,7 @@ module Octopress
|
|
31
27
|
end
|
32
28
|
|
33
29
|
def relative_asset_path
|
34
|
-
site_source = Pathname.new
|
30
|
+
site_source = Pathname.new Docs.site.source
|
35
31
|
page_source = Pathname.new @base
|
36
32
|
page_source.relative_path_from(site_source).to_s
|
37
33
|
end
|
data/lib/octopress-docs.rb
CHANGED
@@ -6,16 +6,6 @@ require "octopress-docs/version"
|
|
6
6
|
require "octopress-docs/command"
|
7
7
|
|
8
8
|
module Octopress
|
9
|
-
unless defined? Octopress.site
|
10
|
-
def self.site
|
11
|
-
@site
|
12
|
-
end
|
13
|
-
|
14
|
-
def self.site=(site)
|
15
|
-
@site = site
|
16
|
-
end
|
17
|
-
end
|
18
|
-
|
19
9
|
module Docs
|
20
10
|
attr_reader :docs
|
21
11
|
@docs = {}
|
@@ -26,34 +16,38 @@ module Octopress
|
|
26
16
|
File.expand_path(File.join(File.dirname(__FILE__), '../', dir))
|
27
17
|
end
|
28
18
|
|
29
|
-
# Get all doc pages
|
30
|
-
#
|
31
19
|
def self.pages
|
32
|
-
|
20
|
+
doc_pages.values.flatten
|
33
21
|
end
|
34
22
|
|
35
|
-
def self.
|
36
|
-
|
37
|
-
|
38
|
-
|
39
|
-
|
40
|
-
"docs" => plugin_docs(pages),
|
41
|
-
"url" => pages.first.base_url,
|
42
|
-
"type" => pages.first.plugin_type,
|
43
|
-
"description" => pages.first.description,
|
44
|
-
"source_url" => pages.first.source_url
|
45
|
-
}
|
46
|
-
}
|
23
|
+
def self.doc_pages
|
24
|
+
if !@pages
|
25
|
+
@pages = @docs.dup
|
26
|
+
|
27
|
+
@pages.each do |slug, docs|
|
47
28
|
|
29
|
+
# Convert docs to pages
|
30
|
+
#
|
31
|
+
docs.map! { |doc| doc.page }
|
48
32
|
|
49
|
-
|
33
|
+
# Inject docs links from other docs pages
|
34
|
+
#
|
35
|
+
docs.map! do |doc|
|
36
|
+
doc.data = doc.data.merge({
|
37
|
+
'docs' => plugin_page_links(@pages[slug])
|
38
|
+
})
|
39
|
+
doc
|
40
|
+
end
|
41
|
+
end
|
42
|
+
end
|
43
|
+
@pages
|
50
44
|
end
|
51
45
|
|
52
|
-
def self.
|
53
|
-
pages.clone.map { |
|
54
|
-
|
55
|
-
title =
|
56
|
-
url = File.join('/',
|
46
|
+
def self.plugin_page_links(pages)
|
47
|
+
pages.clone.map { |page|
|
48
|
+
data = page.data
|
49
|
+
title = data['link_title'] || data['title'] || page.basename
|
50
|
+
url = File.join('/', data['plugin']['url'], page.url.sub('index.html', ''))
|
57
51
|
|
58
52
|
{
|
59
53
|
'title' => title,
|
@@ -64,6 +58,29 @@ module Octopress
|
|
64
58
|
i['url'].split('/').size
|
65
59
|
}
|
66
60
|
end
|
61
|
+
|
62
|
+
|
63
|
+
# Return a hash of plugin docs information
|
64
|
+
# for Jekyll site payload
|
65
|
+
#
|
66
|
+
def self.pages_info
|
67
|
+
docs = {}
|
68
|
+
|
69
|
+
# Retrieve plugin info from docs
|
70
|
+
#
|
71
|
+
doc_pages.each do |slug, pages|
|
72
|
+
data = pages.first.data
|
73
|
+
docs[slug] = data['plugin'].merge({
|
74
|
+
'pages' => data['docs']
|
75
|
+
})
|
76
|
+
end
|
77
|
+
|
78
|
+
# Sort docs alphabetically by name
|
79
|
+
#
|
80
|
+
docs = Hash[docs.sort_by { |k,v| v['name'] }]
|
81
|
+
|
82
|
+
@pages_info = { 'plugin_docs' => docs }
|
83
|
+
end
|
67
84
|
|
68
85
|
def self.add_plugin_docs(plugin)
|
69
86
|
options = plugin_options(plugin)
|
@@ -80,7 +97,7 @@ module Octopress
|
|
80
97
|
slug: plugin.slug,
|
81
98
|
type: plugin.type,
|
82
99
|
base_url: plugin.docs_url,
|
83
|
-
|
100
|
+
path: plugin.path,
|
84
101
|
source_url: plugin.source_url,
|
85
102
|
website: plugin.website,
|
86
103
|
docs_path: File.join(plugin.assets_path, 'docs'),
|
@@ -89,10 +106,12 @@ module Octopress
|
|
89
106
|
end
|
90
107
|
|
91
108
|
def self.default_options(options)
|
109
|
+
options[:docs] ||= %w{readme changelog}
|
92
110
|
options[:type] ||= 'plugin'
|
93
111
|
options[:slug] = slug(options)
|
94
112
|
options[:base_url] = base_url(options)
|
95
|
-
options[:
|
113
|
+
options[:path] ||= '.'
|
114
|
+
options[:docs_path] ||= File.join(options[:path], 'assets', 'docs')
|
96
115
|
options
|
97
116
|
end
|
98
117
|
|
@@ -109,16 +128,22 @@ module Octopress
|
|
109
128
|
end
|
110
129
|
end
|
111
130
|
|
131
|
+
# Add doc pages for a plugin
|
132
|
+
#
|
133
|
+
# Input: options describing a plugin
|
134
|
+
#
|
135
|
+
# Output: array of docs
|
136
|
+
#
|
112
137
|
def self.add(options)
|
113
|
-
options[:docs] ||= %w{readme changelog}
|
114
138
|
options = default_options(options)
|
115
|
-
options[:docs_path] ||= File.join(options[:dir], 'assets', 'docs')
|
116
139
|
docs = []
|
117
140
|
docs.concat add_asset_docs(options)
|
118
141
|
docs.concat add_root_docs(options, docs)
|
119
142
|
docs.compact!
|
120
143
|
end
|
121
144
|
|
145
|
+
# Add pages from the root of a gem (README, CHANGELOG, etc)
|
146
|
+
#
|
122
147
|
def self.add_root_docs(options, asset_docs=[])
|
123
148
|
root_docs = []
|
124
149
|
options[:docs].each do |doc|
|
@@ -136,12 +161,15 @@ module Octopress
|
|
136
161
|
end
|
137
162
|
|
138
163
|
# Add a single root doc
|
164
|
+
#
|
139
165
|
def self.add_root_doc(filename, options)
|
140
|
-
if file = select_first(options[:
|
166
|
+
if file = select_first(options[:path], filename)
|
141
167
|
add_doc_page(options.merge({file: file}))
|
142
168
|
end
|
143
169
|
end
|
144
170
|
|
171
|
+
# Register a new doc page for a plugin
|
172
|
+
#
|
145
173
|
def self.add_doc_page(options)
|
146
174
|
page = Docs::Doc.new(options)
|
147
175
|
@docs[options[:slug]] ||= []
|
@@ -151,40 +179,58 @@ module Octopress
|
|
151
179
|
|
152
180
|
private
|
153
181
|
|
182
|
+
# Add doc pages from /asset/docs
|
183
|
+
#
|
154
184
|
def self.add_asset_docs(options)
|
155
185
|
docs = []
|
156
|
-
find_doc_pages(options).each do |doc|
|
186
|
+
find_doc_pages(options[:docs_path]).each do |doc|
|
157
187
|
unless doc =~ /^_/
|
158
|
-
opts = options.merge({file: doc,
|
188
|
+
opts = options.merge({file: doc, path: options[:docs_path]})
|
159
189
|
docs << add_doc_page(opts)
|
160
190
|
end
|
161
191
|
end
|
162
192
|
docs
|
163
193
|
end
|
164
194
|
|
165
|
-
|
166
|
-
|
167
|
-
|
168
|
-
file.sub(full_dir+'/', '')
|
169
|
-
end
|
170
|
-
end
|
195
|
+
# Find all files in a directory recursively
|
196
|
+
#
|
197
|
+
def self.find_doc_pages(dir)
|
171
198
|
|
172
|
-
def self.glob_assets(dir)
|
173
199
|
return [] unless Dir.exist? dir
|
174
|
-
|
200
|
+
|
201
|
+
Find.find(dir).to_a.reject do |f|
|
202
|
+
File.directory? f
|
203
|
+
end.map do |f|
|
204
|
+
# truncate file to relative path
|
205
|
+
f.sub(dir+'/', '')
|
206
|
+
end
|
175
207
|
end
|
176
208
|
|
177
209
|
def self.select_first(dir, match)
|
178
210
|
Dir.new(dir).select { |f| f =~/#{match}/i}.first
|
179
211
|
end
|
212
|
+
|
213
|
+
def self.site(options={})
|
214
|
+
@site ||= Octopress.site(site_options.merge(options))
|
215
|
+
end
|
216
|
+
|
217
|
+
def self.site_options
|
218
|
+
source = Docs.gem_dir('site')
|
219
|
+
{
|
220
|
+
'source' => source,
|
221
|
+
'destination' => File.join(source, '/_site'),
|
222
|
+
'layouts' => File.join(source, '/_layouts'),
|
223
|
+
'port' => '4444',
|
224
|
+
'serving' => true,
|
225
|
+
}
|
226
|
+
end
|
180
227
|
end
|
181
228
|
end
|
182
229
|
|
183
230
|
# Add documentation for this plugin
|
184
|
-
|
185
231
|
Octopress::Docs.add({
|
186
232
|
name: "Octopress Docs",
|
187
233
|
description: "The fancy local documentation viewer.",
|
188
234
|
source_url: "https://github.com/octopress/docs",
|
189
|
-
|
235
|
+
path: File.expand_path(File.join(File.dirname(__FILE__), "../"))
|
190
236
|
})
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: octopress-docs
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.0.
|
4
|
+
version: 0.0.12
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Brandon Mathis
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2014-12-
|
11
|
+
date: 2014-12-19 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: jekyll
|
@@ -44,14 +44,14 @@ dependencies:
|
|
44
44
|
requirements:
|
45
45
|
- - "~>"
|
46
46
|
- !ruby/object:Gem::Version
|
47
|
-
version: '
|
47
|
+
version: '2.0'
|
48
48
|
type: :runtime
|
49
49
|
prerelease: false
|
50
50
|
version_requirements: !ruby/object:Gem::Requirement
|
51
51
|
requirements:
|
52
52
|
- - "~>"
|
53
53
|
- !ruby/object:Gem::Version
|
54
|
-
version: '
|
54
|
+
version: '2.0'
|
55
55
|
- !ruby/object:Gem::Dependency
|
56
56
|
name: bundler
|
57
57
|
requirement: !ruby/object:Gem::Requirement
|
@@ -117,22 +117,13 @@ extra_rdoc_files: []
|
|
117
117
|
files:
|
118
118
|
- LICENSE.txt
|
119
119
|
- README.md
|
120
|
-
- docs/Gemfile
|
121
|
-
- docs/Gemfile.lock
|
122
|
-
- docs/_config.yml
|
123
|
-
- docs/_includes/nav.html
|
124
|
-
- docs/_layouts/default.html
|
125
|
-
- docs/_layouts/docs.html
|
126
|
-
- docs/_layouts/docs_index.html
|
127
|
-
- docs/_sass/_solarized.scss
|
128
|
-
- docs/index.html
|
129
|
-
- docs/stylesheets/site.scss
|
130
120
|
- lib/octopress-docs.rb
|
131
121
|
- lib/octopress-docs/command.rb
|
132
122
|
- lib/octopress-docs/doc.rb
|
133
123
|
- lib/octopress-docs/hooks.rb
|
124
|
+
- lib/octopress-docs/jekyll/convertible.rb
|
125
|
+
- lib/octopress-docs/jekyll/page.rb
|
134
126
|
- lib/octopress-docs/liquid_filters.rb
|
135
|
-
- lib/octopress-docs/page.rb
|
136
127
|
- lib/octopress-docs/version.rb
|
137
128
|
homepage: https://github.com/octopress/docs
|
138
129
|
licenses:
|
@@ -154,7 +145,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
154
145
|
version: '0'
|
155
146
|
requirements: []
|
156
147
|
rubyforge_project:
|
157
|
-
rubygems_version: 2.
|
148
|
+
rubygems_version: 2.2.2
|
158
149
|
signing_key:
|
159
150
|
specification_version: 4
|
160
151
|
summary: View docs for Octopress and its plugins
|
data/docs/Gemfile
DELETED
data/docs/Gemfile.lock
DELETED
@@ -1,103 +0,0 @@
|
|
1
|
-
PATH
|
2
|
-
remote: ../
|
3
|
-
specs:
|
4
|
-
octopress-docs (1.0.0)
|
5
|
-
jekyll (~> 1.4.2)
|
6
|
-
octopress (~> 3.0.0.rc.6)
|
7
|
-
octopress-ink (~> 1.0.0.alpha.41)
|
8
|
-
octopress-solarized
|
9
|
-
|
10
|
-
PATH
|
11
|
-
remote: ../../cli
|
12
|
-
specs:
|
13
|
-
octopress (3.0.0.rc.6)
|
14
|
-
jekyll (~> 1.4.3)
|
15
|
-
mercenary (~> 0.3.2)
|
16
|
-
|
17
|
-
PATH
|
18
|
-
remote: ../../ink
|
19
|
-
specs:
|
20
|
-
octopress-ink (1.0.0.alpha.41)
|
21
|
-
jekyll (~> 1.4.3)
|
22
|
-
sass (~> 3.3.0)
|
23
|
-
|
24
|
-
PATH
|
25
|
-
remote: ../../solarized
|
26
|
-
specs:
|
27
|
-
octopress-solarized (1.0.0.alpha.3)
|
28
|
-
octopress-ink (~> 1.0.0.alpha.41)
|
29
|
-
|
30
|
-
GEM
|
31
|
-
remote: https://rubygems.org/
|
32
|
-
specs:
|
33
|
-
blankslate (2.1.2.4)
|
34
|
-
classifier (1.3.4)
|
35
|
-
fast-stemmer (>= 1.0.0)
|
36
|
-
coderay (1.1.0)
|
37
|
-
colorator (0.1)
|
38
|
-
columnize (0.3.6)
|
39
|
-
commander (4.1.6)
|
40
|
-
highline (~> 1.6.11)
|
41
|
-
debugger (1.6.6)
|
42
|
-
columnize (>= 0.3.1)
|
43
|
-
debugger-linecache (~> 1.2.0)
|
44
|
-
debugger-ruby_core_source (~> 1.3.2)
|
45
|
-
debugger-linecache (1.2.0)
|
46
|
-
debugger-ruby_core_source (1.3.2)
|
47
|
-
fast-stemmer (1.0.2)
|
48
|
-
ffi (1.9.3)
|
49
|
-
highline (1.6.21)
|
50
|
-
jekyll (1.4.3)
|
51
|
-
classifier (~> 1.3)
|
52
|
-
colorator (~> 0.1)
|
53
|
-
commander (~> 4.1.3)
|
54
|
-
liquid (~> 2.5.5)
|
55
|
-
listen (~> 1.3)
|
56
|
-
maruku (~> 0.7.0)
|
57
|
-
pygments.rb (~> 0.5.0)
|
58
|
-
redcarpet (~> 2.3.0)
|
59
|
-
safe_yaml (~> 0.9.7)
|
60
|
-
toml (~> 0.1.0)
|
61
|
-
liquid (2.5.5)
|
62
|
-
listen (1.3.1)
|
63
|
-
rb-fsevent (>= 0.9.3)
|
64
|
-
rb-inotify (>= 0.9)
|
65
|
-
rb-kqueue (>= 0.2)
|
66
|
-
maruku (0.7.1)
|
67
|
-
mercenary (0.3.2)
|
68
|
-
method_source (0.8.2)
|
69
|
-
parslet (1.5.0)
|
70
|
-
blankslate (~> 2.0)
|
71
|
-
posix-spawn (0.3.8)
|
72
|
-
pry (0.9.12.6)
|
73
|
-
coderay (~> 1.0)
|
74
|
-
method_source (~> 0.8)
|
75
|
-
slop (~> 3.4)
|
76
|
-
pry-debugger (0.2.2)
|
77
|
-
debugger (~> 1.3)
|
78
|
-
pry (~> 0.9.10)
|
79
|
-
pygments.rb (0.5.4)
|
80
|
-
posix-spawn (~> 0.3.6)
|
81
|
-
yajl-ruby (~> 1.1.0)
|
82
|
-
rb-fsevent (0.9.4)
|
83
|
-
rb-inotify (0.9.3)
|
84
|
-
ffi (>= 0.5.0)
|
85
|
-
rb-kqueue (0.2.2)
|
86
|
-
ffi (>= 0.5.0)
|
87
|
-
redcarpet (2.3.0)
|
88
|
-
safe_yaml (0.9.7)
|
89
|
-
sass (3.3.4)
|
90
|
-
slop (3.5.0)
|
91
|
-
toml (0.1.1)
|
92
|
-
parslet (~> 1.5.0)
|
93
|
-
yajl-ruby (1.1.0)
|
94
|
-
|
95
|
-
PLATFORMS
|
96
|
-
ruby
|
97
|
-
|
98
|
-
DEPENDENCIES
|
99
|
-
octopress!
|
100
|
-
octopress-docs!
|
101
|
-
octopress-ink!
|
102
|
-
octopress-solarized!
|
103
|
-
pry-debugger
|
data/docs/_config.yml
DELETED
data/docs/_includes/nav.html
DELETED
data/docs/_layouts/default.html
DELETED
data/docs/_layouts/docs.html
DELETED
@@ -1,15 +0,0 @@
|
|
1
|
-
---
|
2
|
-
layout: default
|
3
|
-
---
|
4
|
-
{% include nav.html %}
|
5
|
-
|
6
|
-
{{ content }}
|
7
|
-
|
8
|
-
{% assign doc_pages = plugin_docs[page.plugin.slug].docs %}
|
9
|
-
{% if doc_pages.size > 1 %}
|
10
|
-
<nav class='plugin-nav' role='navigation'>
|
11
|
-
{% for doc in doc_pages %}
|
12
|
-
<a href="{{ doc.url }}">{{ doc.title }}</a>
|
13
|
-
{% endfor %}
|
14
|
-
</nav>
|
15
|
-
{% endif %}
|
data/docs/_sass/_solarized.scss
DELETED
@@ -1 +0,0 @@
|
|
1
|
-
pre .gd:after,pre .gd .x:after,pre .gi:after,pre .gi .x:after{content:"";position:absolute;z-index:-1;left:0;right:0;top:0;bottom:0}.code-highlight-pre{background:#002731}.code-highlight-row.numbered:before{color:#586e75;background:#073642;border-right:1px solid #00232c;box-shadow:#083e4b -1px 0 inset;text-shadow:#021014 0 -1px}.marked-line .code-highlight-line:before{background:rgba(0,186,255,0.13)}.marked-line.numbered:before{background:rgba(0,186,255,0.13);border-right-color:rgba(0,112,153,0.13)}.highlight pre,pre:not(.code-highlight-pre),.code-highlight{border:1px solid #05232b;background:#002b36;color:#93a1a1}pre span{color:#93a1a1}pre .c{color:#586e75;font-style:italic}pre .cm{color:#586e75;font-style:italic}pre .cp{color:#586e75;font-style:italic}pre .c1{color:#586e75;font-style:italic}pre .cs{color:#586e75;font-weight:bold;font-style:italic}pre .err{color:#dc322f;background:none}pre .k{color:#cb4b16}pre .o{color:#93a1a1;font-weight:bold}pre .p{color:#93a1a1}pre .ow{color:#2aa198;font-weight:bold}pre .gd{color:#93a1a1}pre .gd:after{background:#372c34}pre .gd .x{color:#93a1a1}pre .gd .x:after{background:#4d2d33}pre .ge{color:#93a1a1;font-style:italic}pre .gh{color:#586e75}pre .gi{color:#93a1a1}pre .gi:after{background:#1a412b}pre .gi .x{color:#93a1a1}pre .gi .x:after{background:#355720}pre .go{color:#839496}pre .gp{color:#2aa198}pre .gs{color:#93a1a1;font-weight:bold}pre .gu{color:#6c71c4}pre .gt{color:#dc322f}pre .kc{color:#859900;font-weight:bold}pre .kd{color:#268bd2}pre .kp{color:#cb4b16;font-weight:bold}pre .kr{color:#d33682;font-weight:bold}pre .kt{color:#2aa198}pre .n{color:#268bd2}pre .na{color:#268bd2}pre .nb{color:#859900}pre .nc{color:#d33682}pre .no{color:#b58900}pre .ni{color:#d33682}pre .nl{color:#859900}pre .ne{color:#268bd2;font-weight:bold}pre .nf{color:#268bd2;font-weight:bold}pre .nn{color:#b58900}pre .nt{color:#268bd2;font-weight:bold}pre .nx{color:#b58900}pre .bp{color:#93a1a1}pre .vc{color:#859900}pre .vg{color:#268bd2}pre .vi{color:#268bd2}pre .nv{color:#268bd2}pre .w{color:#657b83}pre .mf{color:#2aa198}pre .m{color:#2aa198}pre .mh{color:#2aa198}pre .mi{color:#2aa198}pre .mo{color:#2aa198}pre .s{color:#2aa198}pre .sb{color:#859900}pre .sc{color:#859900}pre .sd{color:#2aa198}pre .s2{color:#2aa198}pre .se{color:#dc322f}pre .sh{color:#859900}pre .si{color:#268bd2}pre .sx{color:#859900}pre .sr{color:#2aa198}pre .s1{color:#2aa198}pre .ss{color:#cb4b16}pre .il{color:#b58900}code,kbd,samp,tt{color:inherit;background-color:rgba(255,255,255,0.3);border:1px solid rgba(0,0,0,0.1);font-family:"Source Code Pro",Inconsolata-dz,Inconsolata,Menlo,Monaco,Consolas,"Liberation Mono",Courier,monospace;border-radius:3px;font-size:0.85em}code:before,code:after,kbd:before,kbd:after,samp:before,samp:after,tt:before,tt:after{content:"\00a0";letter-spacing:-0.2em}pre code{border:none;background:none;border-raidus:0;font-size:inherit}pre code:before,pre code:after{content:none}pre,pre code{font-size:13px;font-family:"Source Code Pro",Inconsolata-dz,Inconsolata,Menlo,Monaco,Consolas,"Liberation Mono",Courier,monospace}pre *,pre code *{-moz-box-sizing:border-box;box-sizing:border-box}.highlight pre,pre:not(.code-highlight-pre),.code-highlight{overflow:scroll;overflow-y:hidden;overflow-x:auto;line-height:1.45em}.highlight pre span,pre:not(.code-highlight-pre) span,.code-highlight span{font-style:normal;font-weight:normal}.code-highlight-figure{margin:1.8em 0;font-size:14px;background:none;padding:0;border:0}.code-highlight-figure *{-moz-box-sizing:border-box;box-sizing:border-box}.code-highlight-figure pre{margin-top:0;margin-bottom:0}.code-highlight-caption{position:relative;text-align:center;line-height:2em;text-shadow:rgba(255,255,255,0.8) 0 1px 0;color:#474747;font-weight:normal;margin-bottom:0;background-color:#ccc;background-image:-webkit-linear-gradient(#fff, #f0f0f0 6%, #e5e5e5 90%, #e5e5e5);background-image:linear-gradient(#fff, #f0f0f0 6%, #e5e5e5 90%, #e5e5e5);border-top-left-radius:5px;border-top-right-radius:5px;font-family:"Helvetica Neue", Arial, "Lucida Grande", "Lucida Sans Unicode", Lucida, sans-serif;border:1px solid #cbcbcb}.code-highlight-caption+.code-highlight{border-top:0}.code-highlight-caption-link{position:absolute;right:.8em;color:#666;z-index:1;text-shadow:rgba(255,255,255,0.8) 0 1px 0;padding-left:3em}.highlight pre,pre:not(.code-highlight-pre){padding:1em .8rem;border-radius:.4em;margin:1.8em 0}.code-highlight-pre{width:100%;margin-bottom:0;display:table}.code-highlight-row{display:table-row;width:100%}.code-highlight-row:before,.code-highlight-row .code-highlight-line{padding-left:1.6em;padding-right:1.6em}.code-highlight-row:first-child:before,.code-highlight-row:first-child .code-highlight-line{padding-top:0.8em}.code-highlight-row:last-child:before,.code-highlight-row:last-child .code-highlight-line{padding-bottom:0.8em}.code-highlight-row.numbered:before,.code-highlight-row.numbered .code-highlight-line{padding-left:0.8em;padding-right:0.8em}.code-highlight-row.numbered:before{display:table-cell;content:attr(data-line);min-width:1.2em;text-align:right;line-height:1.45em}.code-highlight-line{display:table-cell;width:100%;position:relative;z-index:1}.marked-line{position:relative}.marked-line .code-highlight-line:before{content:"";position:absolute;left:0;top:0;bottom:0;right:0;border-right:1px solid rgba(0,186,255,0.13)}.marked-line.unnumbered .code-highlight-line:before{border-left:3px solid rgba(0,186,255,0.5)}.marked-line.numbered:before{border-left:3px solid rgba(0,186,255,0.5)}.start-marked-line:before,.start-marked-line .code-highlight-line:before{border-top:1px solid rgba(0,186,255,0.13)}.end-marked-line:before,.end-marked-line .code-highlight-line:before{border-bottom:1px solid rgba(0,186,255,0.13)}
|
data/docs/index.html
DELETED
@@ -1,13 +0,0 @@
|
|
1
|
-
---
|
2
|
-
layout: docs_index
|
3
|
-
---
|
4
|
-
|
5
|
-
{% for plugin in plugin_docs %}
|
6
|
-
<ul class='plugin'>
|
7
|
-
<li>
|
8
|
-
<a href="/{{ plugin[1].url }}">{{ plugin[1].name }}</a>{% if plugin[1].description %} - {{ plugin[1].description }}{% endif %}
|
9
|
-
{% assign source = plugin[1].source_url %}
|
10
|
-
{% if source %} - {{ source | docs_source_url }}{% endif %}
|
11
|
-
</li>
|
12
|
-
</ul>
|
13
|
-
{% endfor %}
|
data/docs/stylesheets/site.scss
DELETED