nanoc 2.2.2 → 3.0.0a1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (116) hide show
  1. data/bin/nanoc +29 -11
  2. data/bin/nanoc-select +85 -0
  3. metadata +27 -161
  4. data/ChangeLog +0 -3
  5. data/LICENSE +0 -19
  6. data/README +0 -75
  7. data/Rakefile +0 -76
  8. data/lib/nanoc.rb +0 -73
  9. data/lib/nanoc/base.rb +0 -26
  10. data/lib/nanoc/base/asset.rb +0 -117
  11. data/lib/nanoc/base/asset_defaults.rb +0 -21
  12. data/lib/nanoc/base/asset_rep.rb +0 -282
  13. data/lib/nanoc/base/binary_filter.rb +0 -44
  14. data/lib/nanoc/base/code.rb +0 -41
  15. data/lib/nanoc/base/compiler.rb +0 -67
  16. data/lib/nanoc/base/core_ext.rb +0 -2
  17. data/lib/nanoc/base/core_ext/hash.rb +0 -78
  18. data/lib/nanoc/base/core_ext/string.rb +0 -8
  19. data/lib/nanoc/base/data_source.rb +0 -286
  20. data/lib/nanoc/base/defaults.rb +0 -30
  21. data/lib/nanoc/base/filter.rb +0 -93
  22. data/lib/nanoc/base/layout.rb +0 -91
  23. data/lib/nanoc/base/notification_center.rb +0 -66
  24. data/lib/nanoc/base/page.rb +0 -132
  25. data/lib/nanoc/base/page_defaults.rb +0 -20
  26. data/lib/nanoc/base/page_rep.rb +0 -324
  27. data/lib/nanoc/base/plugin.rb +0 -71
  28. data/lib/nanoc/base/proxies.rb +0 -5
  29. data/lib/nanoc/base/proxies/asset_proxy.rb +0 -29
  30. data/lib/nanoc/base/proxies/asset_rep_proxy.rb +0 -26
  31. data/lib/nanoc/base/proxies/layout_proxy.rb +0 -25
  32. data/lib/nanoc/base/proxies/page_proxy.rb +0 -35
  33. data/lib/nanoc/base/proxies/page_rep_proxy.rb +0 -28
  34. data/lib/nanoc/base/proxy.rb +0 -37
  35. data/lib/nanoc/base/router.rb +0 -72
  36. data/lib/nanoc/base/site.rb +0 -274
  37. data/lib/nanoc/base/template.rb +0 -64
  38. data/lib/nanoc/binary_filters.rb +0 -1
  39. data/lib/nanoc/binary_filters/image_science_thumbnail.rb +0 -28
  40. data/lib/nanoc/cli.rb +0 -9
  41. data/lib/nanoc/cli/base.rb +0 -132
  42. data/lib/nanoc/cli/commands.rb +0 -10
  43. data/lib/nanoc/cli/commands/autocompile.rb +0 -80
  44. data/lib/nanoc/cli/commands/compile.rb +0 -311
  45. data/lib/nanoc/cli/commands/create_layout.rb +0 -85
  46. data/lib/nanoc/cli/commands/create_page.rb +0 -85
  47. data/lib/nanoc/cli/commands/create_site.rb +0 -323
  48. data/lib/nanoc/cli/commands/create_template.rb +0 -76
  49. data/lib/nanoc/cli/commands/help.rb +0 -69
  50. data/lib/nanoc/cli/commands/info.rb +0 -125
  51. data/lib/nanoc/cli/commands/switch.rb +0 -141
  52. data/lib/nanoc/cli/commands/update.rb +0 -91
  53. data/lib/nanoc/cli/logger.rb +0 -72
  54. data/lib/nanoc/data_sources.rb +0 -2
  55. data/lib/nanoc/data_sources/filesystem.rb +0 -707
  56. data/lib/nanoc/data_sources/filesystem_combined.rb +0 -495
  57. data/lib/nanoc/extra.rb +0 -6
  58. data/lib/nanoc/extra/auto_compiler.rb +0 -285
  59. data/lib/nanoc/extra/context.rb +0 -22
  60. data/lib/nanoc/extra/core_ext.rb +0 -2
  61. data/lib/nanoc/extra/core_ext/hash.rb +0 -54
  62. data/lib/nanoc/extra/core_ext/time.rb +0 -13
  63. data/lib/nanoc/extra/file_proxy.rb +0 -29
  64. data/lib/nanoc/extra/vcs.rb +0 -48
  65. data/lib/nanoc/extra/vcses.rb +0 -5
  66. data/lib/nanoc/extra/vcses/bazaar.rb +0 -21
  67. data/lib/nanoc/extra/vcses/dummy.rb +0 -20
  68. data/lib/nanoc/extra/vcses/git.rb +0 -21
  69. data/lib/nanoc/extra/vcses/mercurial.rb +0 -21
  70. data/lib/nanoc/extra/vcses/subversion.rb +0 -21
  71. data/lib/nanoc/filters.rb +0 -16
  72. data/lib/nanoc/filters/bluecloth.rb +0 -13
  73. data/lib/nanoc/filters/erb.rb +0 -19
  74. data/lib/nanoc/filters/erubis.rb +0 -14
  75. data/lib/nanoc/filters/haml.rb +0 -21
  76. data/lib/nanoc/filters/markaby.rb +0 -14
  77. data/lib/nanoc/filters/maruku.rb +0 -14
  78. data/lib/nanoc/filters/old.rb +0 -19
  79. data/lib/nanoc/filters/rainpress.rb +0 -13
  80. data/lib/nanoc/filters/rdiscount.rb +0 -13
  81. data/lib/nanoc/filters/rdoc.rb +0 -23
  82. data/lib/nanoc/filters/redcloth.rb +0 -14
  83. data/lib/nanoc/filters/relativize_paths.rb +0 -16
  84. data/lib/nanoc/filters/relativize_paths_in_css.rb +0 -16
  85. data/lib/nanoc/filters/relativize_paths_in_html.rb +0 -16
  86. data/lib/nanoc/filters/rubypants.rb +0 -14
  87. data/lib/nanoc/filters/sass.rb +0 -18
  88. data/lib/nanoc/helpers.rb +0 -9
  89. data/lib/nanoc/helpers/blogging.rb +0 -217
  90. data/lib/nanoc/helpers/capturing.rb +0 -63
  91. data/lib/nanoc/helpers/filtering.rb +0 -54
  92. data/lib/nanoc/helpers/html_escape.rb +0 -25
  93. data/lib/nanoc/helpers/link_to.rb +0 -113
  94. data/lib/nanoc/helpers/render.rb +0 -49
  95. data/lib/nanoc/helpers/tagging.rb +0 -56
  96. data/lib/nanoc/helpers/text.rb +0 -38
  97. data/lib/nanoc/helpers/xml_sitemap.rb +0 -63
  98. data/lib/nanoc/routers.rb +0 -3
  99. data/lib/nanoc/routers/default.rb +0 -54
  100. data/lib/nanoc/routers/no_dirs.rb +0 -66
  101. data/lib/nanoc/routers/versioned.rb +0 -79
  102. data/vendor/cri/ChangeLog +0 -0
  103. data/vendor/cri/LICENSE +0 -19
  104. data/vendor/cri/NEWS +0 -0
  105. data/vendor/cri/README +0 -4
  106. data/vendor/cri/Rakefile +0 -25
  107. data/vendor/cri/lib/cri.rb +0 -12
  108. data/vendor/cri/lib/cri/base.rb +0 -153
  109. data/vendor/cri/lib/cri/command.rb +0 -104
  110. data/vendor/cri/lib/cri/core_ext.rb +0 -8
  111. data/vendor/cri/lib/cri/core_ext/string.rb +0 -41
  112. data/vendor/cri/lib/cri/option_parser.rb +0 -186
  113. data/vendor/cri/test/test_base.rb +0 -6
  114. data/vendor/cri/test/test_command.rb +0 -6
  115. data/vendor/cri/test/test_core_ext.rb +0 -21
  116. data/vendor/cri/test/test_option_parser.rb +0 -279
data/bin/nanoc CHANGED
@@ -1,15 +1,33 @@
1
1
  #!/usr/bin/env ruby
2
+ # encoding: utf-8
2
3
 
3
- # Add lib to load path
4
- $LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + '/../lib'))
4
+ # Find version
5
+ version_file_path = File.expand_path('~/.nanoc-select-version')
6
+ if !File.exist?(version_file_path)
7
+ warn 'WARNING: No nanoc version has been selected; using nanoc 3.x by default. Select a version using `nanoc-select` to make this warning go away.'
8
+ version = 3
9
+ else
10
+ version = File.read(version_file_path).to_i
11
+ end
5
12
 
6
- # Load nanoc
7
- require 'nanoc'
8
- require 'nanoc/cli'
13
+ # Determine nanoc executable name
14
+ VERSION_MAP = {
15
+ 2 => 'nanoc2',
16
+ 3 => 'nanoc3'
17
+ }
18
+ name = VERSION_MAP[version]
19
+ if name.nil?
20
+ $stderr.puts "Unsupported nanoc version number: #{version}. Supported versions: #{VERSION_MAP.keys.join(', ')}."
21
+ exit 1
22
+ end
9
23
 
10
- # Load custom code that can't be load later
11
- Dir['lib/commands/*.rb'].each { |f| require f }
12
- Dir['lib/data_sources/*.rb'].each { |f| require f }
13
-
14
- # Run base
15
- Nanoc::CLI::Base.new.run(ARGV)
24
+ # Run nanoc
25
+ begin
26
+ exec name, *ARGV
27
+ rescue Errno::ENOENT
28
+ $stderr.puts "Could not execute #{name}, which is your selected nanoc version. Make sure that #{name} is installed and that it is in your $PATH."
29
+ $stderr.puts
30
+ $stderr.puts "* To install #{name}, run `gem install #{name}`."
31
+ $stderr.puts "* To select a different version of nanoc, run `nanoc-select`."
32
+ exit 1
33
+ end
@@ -0,0 +1,85 @@
1
+ #!/usr/bin/env ruby
2
+ # encoding: utf-8
3
+
4
+ $LOAD_PATH.unshift(File.dirname(__FILE__) + '/../lib')
5
+
6
+ require 'nanoc-select'
7
+ require 'getoptlong'
8
+
9
+ def version(io)
10
+ io.puts "nanoc-select #{NanocSelect::VERSION} (c) 2010 Denis Defreyne."
11
+ io.puts "Ruby #{RUBY_VERSION} (#{RUBY_RELEASE_DATE}) running on #{RUBY_PLATFORM}"
12
+ end
13
+
14
+ def usage(io, option_definitions)
15
+ io.puts "usage: #{$0} version"
16
+ io.puts
17
+ io.puts <<-EOS
18
+ Since nanoc 3.x is not backwards compatible with nanoc 2.x, it can be useful
19
+ to have multiple versions of nanoc installed simultaneously. In order to avoid
20
+ having to type `nanoc2` or `nanoc3`, the `nanoc-select` tool can be used to
21
+ make `nanoc` invoke either `nanoc2` or `nanoc3`.
22
+ EOS
23
+ io.puts
24
+ io.puts "Options:"
25
+ io.puts
26
+ option_definitions.each do |opt_def|
27
+ io.puts " #{opt_def[1]} #{format '%-10s', opt_def[0]} #{opt_def[-1]}"
28
+ end
29
+ end
30
+
31
+ def list(io)
32
+ io.puts 'Available nanoc versions:'
33
+ io.puts
34
+ NanocSelect::VERSIONS.each do |v|
35
+ io.puts " #{v} -- nanoc #{v}.x"
36
+ end
37
+ end
38
+
39
+ # Parse options
40
+ begin
41
+ option_definitions = [
42
+ [ '--help', '-h', GetoptLong::NO_ARGUMENT, 'show this help and exit' ],
43
+ [ '--version', '-v', GetoptLong::NO_ARGUMENT, 'show version information and exit' ],
44
+ [ '--list', '-l', GetoptLong::NO_ARGUMENT, 'list available versions and exit' ]
45
+ ]
46
+ options = GetoptLong.new(*option_definitions.map { |od| od[0..-2] })
47
+ options.each do |opt, arg|
48
+ case opt
49
+ when '--help'
50
+ usage($stdout, option_definitions)
51
+ exit 0
52
+
53
+ when '--version'
54
+ version($stdout)
55
+ exit 0
56
+
57
+ when '--list'
58
+ list($stdout)
59
+ exit 0
60
+ end
61
+ end
62
+ rescue GetoptLong::InvalidOption
63
+ $stderr.puts
64
+ usage($stderr, option_definitions)
65
+ exit 1
66
+ end
67
+
68
+ # Get version argument
69
+ if ARGV.size != 1
70
+ usage($stderr, option_definitions)
71
+ exit 1
72
+ end
73
+ version_raw = ARGV[0]
74
+ version = version_raw.to_i
75
+ if !NanocSelect::VERSIONS.include?(version)
76
+ $stderr.puts "There is no nanoc version #{version_raw}!"
77
+ $stderr.puts
78
+ list($stderr)
79
+ exit 1
80
+ end
81
+
82
+ # Switch
83
+ version_file_path = File.expand_path('~/.nanoc-select-version')
84
+ File.open(version_file_path, 'w') { |io| io.write(version.to_s + "\n") }
85
+ puts "Switched to nanoc version #{version}."
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: nanoc
3
3
  version: !ruby/object:Gem::Version
4
- version: 2.2.2
4
+ version: 3.0.0a1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Denis Defreyne
@@ -9,192 +9,58 @@ autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
11
 
12
- date: 2009-05-18 00:00:00 +02:00
12
+ date: 2010-02-20 00:00:00 +01:00
13
13
  default_executable:
14
- dependencies: []
15
-
16
- description: a tool that runs on your local computer and compiles Markdown, Textile, Haml, ... documents into static web pages
14
+ dependencies:
15
+ - !ruby/object:Gem::Dependency
16
+ name: nanoc3
17
+ type: :runtime
18
+ version_requirement:
19
+ version_requirements: !ruby/object:Gem::Requirement
20
+ requirements:
21
+ - - ">="
22
+ - !ruby/object:Gem::Version
23
+ version: 3.0.0
24
+ version:
25
+ description: a web publishing system written in Ruby for building small to medium-sized websites.
17
26
  email: denis.defreyne@stoneship.org
18
27
  executables:
19
28
  - nanoc
29
+ - nanoc-select
20
30
  extensions: []
21
31
 
22
- extra_rdoc_files:
23
- - README
32
+ extra_rdoc_files: []
33
+
24
34
  files:
25
- - README
26
- - LICENSE
27
- - ChangeLog
28
- - Rakefile
29
35
  - bin/nanoc
30
- - lib/nanoc/base/asset.rb
31
- - lib/nanoc/base/asset_defaults.rb
32
- - lib/nanoc/base/asset_rep.rb
33
- - lib/nanoc/base/binary_filter.rb
34
- - lib/nanoc/base/code.rb
35
- - lib/nanoc/base/compiler.rb
36
- - lib/nanoc/base/core_ext/hash.rb
37
- - lib/nanoc/base/core_ext/string.rb
38
- - lib/nanoc/base/core_ext.rb
39
- - lib/nanoc/base/data_source.rb
40
- - lib/nanoc/base/defaults.rb
41
- - lib/nanoc/base/filter.rb
42
- - lib/nanoc/base/layout.rb
43
- - lib/nanoc/base/notification_center.rb
44
- - lib/nanoc/base/page.rb
45
- - lib/nanoc/base/page_defaults.rb
46
- - lib/nanoc/base/page_rep.rb
47
- - lib/nanoc/base/plugin.rb
48
- - lib/nanoc/base/proxies/asset_proxy.rb
49
- - lib/nanoc/base/proxies/asset_rep_proxy.rb
50
- - lib/nanoc/base/proxies/layout_proxy.rb
51
- - lib/nanoc/base/proxies/page_proxy.rb
52
- - lib/nanoc/base/proxies/page_rep_proxy.rb
53
- - lib/nanoc/base/proxies.rb
54
- - lib/nanoc/base/proxy.rb
55
- - lib/nanoc/base/router.rb
56
- - lib/nanoc/base/site.rb
57
- - lib/nanoc/base/template.rb
58
- - lib/nanoc/base.rb
59
- - lib/nanoc/binary_filters/image_science_thumbnail.rb
60
- - lib/nanoc/binary_filters.rb
61
- - lib/nanoc/cli/base.rb
62
- - lib/nanoc/cli/commands/autocompile.rb
63
- - lib/nanoc/cli/commands/compile.rb
64
- - lib/nanoc/cli/commands/create_layout.rb
65
- - lib/nanoc/cli/commands/create_page.rb
66
- - lib/nanoc/cli/commands/create_site.rb
67
- - lib/nanoc/cli/commands/create_template.rb
68
- - lib/nanoc/cli/commands/help.rb
69
- - lib/nanoc/cli/commands/info.rb
70
- - lib/nanoc/cli/commands/switch.rb
71
- - lib/nanoc/cli/commands/update.rb
72
- - lib/nanoc/cli/commands.rb
73
- - lib/nanoc/cli/logger.rb
74
- - lib/nanoc/cli.rb
75
- - lib/nanoc/data_sources/filesystem.rb
76
- - lib/nanoc/data_sources/filesystem_combined.rb
77
- - lib/nanoc/data_sources.rb
78
- - lib/nanoc/extra/auto_compiler.rb
79
- - lib/nanoc/extra/context.rb
80
- - lib/nanoc/extra/core_ext/hash.rb
81
- - lib/nanoc/extra/core_ext/time.rb
82
- - lib/nanoc/extra/core_ext.rb
83
- - lib/nanoc/extra/file_proxy.rb
84
- - lib/nanoc/extra/vcs.rb
85
- - lib/nanoc/extra/vcses/bazaar.rb
86
- - lib/nanoc/extra/vcses/dummy.rb
87
- - lib/nanoc/extra/vcses/git.rb
88
- - lib/nanoc/extra/vcses/mercurial.rb
89
- - lib/nanoc/extra/vcses/subversion.rb
90
- - lib/nanoc/extra/vcses.rb
91
- - lib/nanoc/extra.rb
92
- - lib/nanoc/filters/bluecloth.rb
93
- - lib/nanoc/filters/erb.rb
94
- - lib/nanoc/filters/erubis.rb
95
- - lib/nanoc/filters/haml.rb
96
- - lib/nanoc/filters/markaby.rb
97
- - lib/nanoc/filters/maruku.rb
98
- - lib/nanoc/filters/old.rb
99
- - lib/nanoc/filters/rainpress.rb
100
- - lib/nanoc/filters/rdiscount.rb
101
- - lib/nanoc/filters/rdoc.rb
102
- - lib/nanoc/filters/redcloth.rb
103
- - lib/nanoc/filters/relativize_paths.rb
104
- - lib/nanoc/filters/relativize_paths_in_css.rb
105
- - lib/nanoc/filters/relativize_paths_in_html.rb
106
- - lib/nanoc/filters/rubypants.rb
107
- - lib/nanoc/filters/sass.rb
108
- - lib/nanoc/filters.rb
109
- - lib/nanoc/helpers/blogging.rb
110
- - lib/nanoc/helpers/capturing.rb
111
- - lib/nanoc/helpers/filtering.rb
112
- - lib/nanoc/helpers/html_escape.rb
113
- - lib/nanoc/helpers/link_to.rb
114
- - lib/nanoc/helpers/render.rb
115
- - lib/nanoc/helpers/tagging.rb
116
- - lib/nanoc/helpers/text.rb
117
- - lib/nanoc/helpers/xml_sitemap.rb
118
- - lib/nanoc/helpers.rb
119
- - lib/nanoc/routers/default.rb
120
- - lib/nanoc/routers/no_dirs.rb
121
- - lib/nanoc/routers/versioned.rb
122
- - lib/nanoc/routers.rb
123
- - lib/nanoc.rb
124
- - vendor/cri/ChangeLog
125
- - vendor/cri/lib/cri/base.rb
126
- - vendor/cri/lib/cri/command.rb
127
- - vendor/cri/lib/cri/core_ext/string.rb
128
- - vendor/cri/lib/cri/core_ext.rb
129
- - vendor/cri/lib/cri/option_parser.rb
130
- - vendor/cri/lib/cri.rb
131
- - vendor/cri/LICENSE
132
- - vendor/cri/NEWS
133
- - vendor/cri/Rakefile
134
- - vendor/cri/README
135
- - vendor/cri/test/test_base.rb
136
- - vendor/cri/test/test_command.rb
137
- - vendor/cri/test/test_core_ext.rb
138
- - vendor/cri/test/test_option_parser.rb
36
+ - bin/nanoc-select
139
37
  has_rdoc: true
140
38
  homepage: http://nanoc.stoneship.org/
141
39
  licenses: []
142
40
 
143
- post_install_message: |-
144
- ------------------------------------------------------------------------------
145
- Thanks for installing nanoc 2.2! Here are some resources to help you get started:
146
-
147
- * The tutorial at <http://nanoc.stoneship.org/help/tutorial/>
148
- * The manual at <http://nanoc.stoneship.org/help/manual/>
149
- * The discussion group at <http://groups.google.com/group/nanoc>
150
-
151
- Be sure to check out the nanoc blog at <http://nanoc.stoneship.org/blog/> for
152
- details about this release.
153
-
154
- Enjoy!
155
- ------------------------------------------------------------------------------
156
- rdoc_options:
157
- - --title
158
- - nanoc
159
- - --main
160
- - README
161
- - --charset
162
- - utf-8
163
- - --exclude
164
- - lib/nanoc/cli/commands
165
- - --exclude
166
- - lib/nanoc/binary_filters
167
- - --exclude
168
- - lib/nanoc/extra/vcses
169
- - --exclude
170
- - lib/nanoc/filters
171
- - --exclude
172
- - doc
173
- - --exclude
174
- - test
175
- - --exclude
176
- - vendor
177
- - --line-numbers
41
+ post_install_message:
42
+ rdoc_options: []
43
+
178
44
  require_paths:
179
45
  - lib
180
46
  required_ruby_version: !ruby/object:Gem::Requirement
181
47
  requirements:
182
48
  - - ">="
183
49
  - !ruby/object:Gem::Version
184
- version: 1.8.5
50
+ version: "0"
185
51
  version:
186
52
  required_rubygems_version: !ruby/object:Gem::Requirement
187
53
  requirements:
188
- - - ">="
54
+ - - ">"
189
55
  - !ruby/object:Gem::Version
190
- version: "0"
56
+ version: 1.3.1
191
57
  version:
192
58
  requirements: []
193
59
 
194
- rubyforge_project: nanoc
195
- rubygems_version: 1.3.3
60
+ rubyforge_project:
61
+ rubygems_version: 1.3.5
196
62
  signing_key:
197
63
  specification_version: 3
198
- summary: a tool that runs on your local computer and compiles Markdown, Textile, Haml, ... documents into static web pages
64
+ summary: a web publishing system written in Ruby for building small to medium-sized websites.
199
65
  test_files: []
200
66
 
data/ChangeLog DELETED
@@ -1,3 +0,0 @@
1
- For a list of all changes, please see the changelog on the project repository
2
- instead (http://projects.stoneship.org/hg/shared/nanoc/shortlog). For release
3
- notes, please see the NEWS file.
data/LICENSE DELETED
@@ -1,19 +0,0 @@
1
- Copyright (c) 2007-2008 Denis Defreyne and contributors
2
-
3
- Permission is hereby granted, free of charge, to any person obtaining a copy
4
- of this software and associated documentation files (the "Software"), to deal
5
- in the Software without restriction, including without limitation the rights
6
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
7
- copies of the Software, and to permit persons to whom the Software is
8
- furnished to do so, subject to the following conditions:
9
-
10
- The above copyright notice and this permission notice shall be included in all
11
- copies or substantial portions of the Software.
12
-
13
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
19
- SOFTWARE.
data/README DELETED
@@ -1,75 +0,0 @@
1
- == Overview
2
-
3
- nanoc is a simple but very flexible static site generator written in Ruby.
4
- It operates on local files, and therefore does not run on the server. nanoc
5
- "compiles" the local source files into HTML (usually), by evaluating eRuby,
6
- Markdown, etc.
7
-
8
- == Documentation
9
-
10
- nanoc's web site, which can be found at http://nanoc.stoneship.org, contains a
11
- few useful resources to help you get started with nanoc:
12
-
13
- * The tutorial at http://nanoc.stoneship.org/help/tutorial
14
- * The manual at http://nanoc.stoneship.org/help/manual
15
-
16
- It is probably also worth checking out and perhaps subscribing to the
17
- discussion groups:
18
-
19
- * The discussion group in English at http://groups.google.com/group/nanoc
20
- * The discussion group in Spanish at http://groups.google.com/group/nanoc-es
21
-
22
- === Source Code Documentation
23
-
24
- The source code is structured in a few directories:
25
-
26
- * *bin* contains the commandline tool aptly named +nanoc+
27
- * *lib*
28
- * *nanoc*
29
- * *base* contains the bare essentials necessary for nanoc to function
30
- * *binary_filters* contains the standard binary filters
31
- (Nanoc::BinaryFilter subclasses) such as the thumbnail filter
32
- * *cli* contains the commandline interface
33
- * *data_sources* contains the standard data sources (Nanoc::DataSource
34
- subclasses), such as the filesystem data source
35
- * *helpers* contains helpers, which provide functionality some sites
36
- may find useful, such as the blogging and tagging helpers
37
- * *extra* contains stuff that is not needed by nanoc itself, but which may
38
- be used by helpers, data sources, filters or routers.
39
- * *filters* contains the standard filters (Nanoc::Filter subclasses) such
40
- as ERB, Markdown, Haml, ...
41
- * *routers* contains the standard routers (Nanoc::Router subclasses)
42
- * *test* contains test fixtures as well as testing code, structured in the
43
- same way as lib/nanoc
44
-
45
- The namespaces (modules) are organised like this:
46
-
47
- * *Nanoc* is the namespace for everything nanoc-related (obviously). The
48
- classes in 'lib/nanoc/base' are part of this module (not Nanoc::Base which
49
- does not exist)
50
- * *BinaryFilters* contains the binary filters
51
- * *CLI* containing everything related to the commandline tool.
52
- * *DataSources* contains the data sources
53
- * *Helpers* contains the helpers
54
- * *Extra* contains useful stuff not needed by nanoc itself
55
- * *Filters* contains the (textual) filters
56
- * *Routers* contains the routers
57
-
58
- The central class in nanoc is Nanoc::Site, so you should start there if you
59
- want to explore nanoc from a technical perspective.
60
-
61
- == Contributors
62
-
63
- (In alphabetical order)
64
-
65
- * Colin Barrett
66
- * Dmitry Bilunov
67
- * Šime Ramov
68
- * "Soryu"
69
- * Dennis Sutch
70
-
71
- Special thanks to Ale Muñoz.
72
-
73
- == Contact
74
-
75
- You can reach me at <denis.defreyne@stoneship.org>.