madness 0.6.1 → 0.6.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +7 -4
- data/lib/madness.rb +2 -34
- data/lib/madness/command_line.rb +3 -0
- data/lib/madness/document.rb +13 -2
- data/lib/madness/refinements/array_refinements.rb +2 -0
- data/lib/madness/refinements/string_refinements.rb +1 -1
- data/lib/madness/search.rb +2 -1
- data/lib/madness/server_base.rb +8 -1
- data/lib/madness/settings.rb +3 -1
- data/lib/madness/static.rb +19 -0
- data/lib/madness/version.rb +1 -1
- metadata +56 -41
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: fc75908a99d4e9dc14baa5d46be80ec7e67aef852d37b506ddd3f608cc82a806
|
4
|
+
data.tar.gz: 5020b3f14501f90770dc45593bd102163c9cc125da90cc60598cf39dc2ec6c00
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 13112e89bef2880f89389b8af54ea59d9e2f22fc495a4136d9b5c832c4bed1457c7b025553c0a0cda9bb30b64bd1205843ec0b6f8ed3d9dae5fadb4509ef801c
|
7
|
+
data.tar.gz: 85a454ac3dd48ba797cd71eb5734334e87ac6a952af4ffafdc67b05c6fe4b6d140d7d0de4bfb4bccc032c0ea45a90b748e21d276f613ca742372d8251eda0dac
|
data/README.md
CHANGED
@@ -81,6 +81,9 @@ For more options, run:
|
|
81
81
|
$ madness --help
|
82
82
|
|
83
83
|
|
84
|
+
If you do not have Ruby installed, you can also
|
85
|
+
[run madness with docker](#docker-image).
|
86
|
+
|
84
87
|
|
85
88
|
Directory Conventions
|
86
89
|
--------------------------------------------------
|
@@ -239,10 +242,10 @@ Madness comes with a command that copies the default theme to a folder of
|
|
239
242
|
your choice, where you can customize it to your taste. Run:
|
240
243
|
|
241
244
|
```shell
|
242
|
-
$ madness create
|
245
|
+
$ madness create theme my_theme
|
243
246
|
```
|
244
247
|
|
245
|
-
Where `
|
248
|
+
Where `my_theme` is the folder that will be created.
|
246
249
|
|
247
250
|
To use the created theme, simply run Madness with the `--theme my_theme`
|
248
251
|
option.
|
@@ -277,10 +280,10 @@ directory as the markdown documentation folder
|
|
277
280
|
$ docker run --rm -it -v $PWD:/docs -p 3000:3000 dannyben/madness
|
278
281
|
```
|
279
282
|
|
280
|
-
For more information see:
|
283
|
+
For more information about the docker image, see:
|
281
284
|
|
282
285
|
- [Madness image on Docker Hub][dockerhub]
|
283
|
-
- [Madness Dockerfile][dockerfile]
|
286
|
+
- [Madness Dockerfile and Docker Compose][dockerfile]
|
284
287
|
|
285
288
|
|
286
289
|
|
data/lib/madness.rb
CHANGED
@@ -1,38 +1,6 @@
|
|
1
|
-
require 'fileutils'
|
2
|
-
require 'singleton'
|
3
|
-
require 'yaml'
|
4
|
-
|
5
|
-
require 'coderay'
|
6
|
-
require 'colsole'
|
7
|
-
require 'commonmarker'
|
8
|
-
require 'docopt'
|
9
|
-
require 'ferret'
|
10
|
-
require 'rack/contrib/try_static'
|
11
|
-
require 'sass'
|
12
|
-
require 'sass/plugin/rack'
|
13
|
-
require 'sinatra/base'
|
14
|
-
require 'sinatra/reloader'
|
15
|
-
require 'slim'
|
16
|
-
require 'naturally'
|
17
|
-
|
18
1
|
require 'byebug' if ENV['BYEBUG']
|
19
2
|
|
20
|
-
require '
|
21
|
-
require 'madness/refinements/array_refinements'
|
22
|
-
|
23
|
-
require 'madness/server_helper'
|
3
|
+
require 'requires'
|
24
4
|
|
25
|
-
|
26
|
-
require 'madness/command_line'
|
27
|
-
require 'madness/directory'
|
28
|
-
require 'madness/document'
|
29
|
-
require 'madness/item'
|
30
|
-
require 'madness/navigation'
|
31
|
-
require 'madness/search'
|
32
|
-
require 'madness/server'
|
33
|
-
require 'madness/server_base'
|
34
|
-
require 'madness/settings'
|
35
|
-
require 'madness/table_of_contents'
|
36
|
-
require 'madness/theme'
|
37
|
-
require 'madness/version'
|
5
|
+
requires 'madness/refinements', 'madness/server_helper', 'madness'
|
38
6
|
|
data/lib/madness/command_line.rb
CHANGED
data/lib/madness/document.rb
CHANGED
@@ -1,3 +1,6 @@
|
|
1
|
+
require 'commonmarker'
|
2
|
+
require 'coderay'
|
3
|
+
|
1
4
|
module Madness
|
2
5
|
|
3
6
|
# Handle a single markdown document.
|
@@ -63,9 +66,9 @@ module Madness
|
|
63
66
|
if File.directory? base
|
64
67
|
@title = File.basename(path).to_label unless path.empty?
|
65
68
|
set_base_attributes_for_directory
|
66
|
-
elsif
|
69
|
+
elsif md_file?
|
70
|
+
@file = md_filename
|
67
71
|
@title = File.basename(base).to_label
|
68
|
-
@file = "#{base}.md"
|
69
72
|
@dir = File.dirname file
|
70
73
|
@type = :file
|
71
74
|
end
|
@@ -135,6 +138,14 @@ module Madness
|
|
135
138
|
CodeRay.scan(code, lang).html opts
|
136
139
|
end
|
137
140
|
end
|
141
|
+
|
142
|
+
def md_file?
|
143
|
+
File.exist?("#{base}.md") || (File.exist?(base) && File.extname(base) == '.md')
|
144
|
+
end
|
145
|
+
|
146
|
+
def md_filename
|
147
|
+
File.extname(base) == '.md' ? base : "#{base}.md"
|
148
|
+
end
|
138
149
|
end
|
139
150
|
end
|
140
151
|
|
data/lib/madness/search.rb
CHANGED
data/lib/madness/server_base.rb
CHANGED
@@ -1,3 +1,10 @@
|
|
1
|
+
require 'rack/contrib/try_static'
|
2
|
+
require 'sass'
|
3
|
+
require 'sass/plugin/rack'
|
4
|
+
require 'sinatra/base'
|
5
|
+
require 'sinatra/reloader'
|
6
|
+
require 'slim'
|
7
|
+
|
1
8
|
module Madness
|
2
9
|
|
3
10
|
# The base class for the sinatra server.
|
@@ -22,7 +29,7 @@ module Madness
|
|
22
29
|
# The CommandLine class and the test suite should both call
|
23
30
|
# `Server.prepare` before calling Server.run!
|
24
31
|
def self.prepare
|
25
|
-
use
|
32
|
+
use Madness::Static, root: "#{config.path}/", :urls => %w[/]
|
26
33
|
set :bind, config.bind
|
27
34
|
set :port, config.port
|
28
35
|
|
data/lib/madness/settings.rb
CHANGED
@@ -0,0 +1,19 @@
|
|
1
|
+
module Madness
|
2
|
+
|
3
|
+
# The Madness::Static middleware delegates requests to
|
4
|
+
# Rack::TryStatic middleware unless the request URI ends with .md
|
5
|
+
class Static
|
6
|
+
def initialize(app, options)
|
7
|
+
@app = app
|
8
|
+
@static = ::Rack::TryStatic.new(app, options)
|
9
|
+
end
|
10
|
+
|
11
|
+
def call(env)
|
12
|
+
if env['PATH_INFO'].end_with? ".md"
|
13
|
+
@app.call env
|
14
|
+
else
|
15
|
+
@static.call env
|
16
|
+
end
|
17
|
+
end
|
18
|
+
end
|
19
|
+
end
|
data/lib/madness/version.rb
CHANGED
metadata
CHANGED
@@ -1,197 +1,211 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: madness
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.6.
|
4
|
+
version: 0.6.2
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Danny Ben Shitrit
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2018-
|
11
|
+
date: 2018-08-08 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
|
-
name:
|
14
|
+
name: coderay
|
15
15
|
requirement: !ruby/object:Gem::Requirement
|
16
16
|
requirements:
|
17
17
|
- - "~>"
|
18
18
|
- !ruby/object:Gem::Version
|
19
|
-
version: '
|
19
|
+
version: '1.1'
|
20
20
|
type: :runtime
|
21
21
|
prerelease: false
|
22
22
|
version_requirements: !ruby/object:Gem::Requirement
|
23
23
|
requirements:
|
24
24
|
- - "~>"
|
25
25
|
- !ruby/object:Gem::Version
|
26
|
-
version: '
|
26
|
+
version: '1.1'
|
27
27
|
- !ruby/object:Gem::Dependency
|
28
|
-
name:
|
28
|
+
name: colsole
|
29
29
|
requirement: !ruby/object:Gem::Requirement
|
30
30
|
requirements:
|
31
31
|
- - "~>"
|
32
32
|
- !ruby/object:Gem::Version
|
33
|
-
version: '
|
33
|
+
version: '0.4'
|
34
34
|
type: :runtime
|
35
35
|
prerelease: false
|
36
36
|
version_requirements: !ruby/object:Gem::Requirement
|
37
37
|
requirements:
|
38
38
|
- - "~>"
|
39
39
|
- !ruby/object:Gem::Version
|
40
|
-
version: '
|
40
|
+
version: '0.4'
|
41
41
|
- !ruby/object:Gem::Dependency
|
42
|
-
name:
|
42
|
+
name: commonmarker
|
43
43
|
requirement: !ruby/object:Gem::Requirement
|
44
44
|
requirements:
|
45
45
|
- - "~>"
|
46
46
|
- !ruby/object:Gem::Version
|
47
|
-
version: '
|
47
|
+
version: '0.17'
|
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: '0.17'
|
55
55
|
- !ruby/object:Gem::Dependency
|
56
|
-
name:
|
56
|
+
name: docopt
|
57
57
|
requirement: !ruby/object:Gem::Requirement
|
58
58
|
requirements:
|
59
59
|
- - "~>"
|
60
60
|
- !ruby/object:Gem::Version
|
61
|
-
version: '
|
61
|
+
version: '0.5'
|
62
62
|
type: :runtime
|
63
63
|
prerelease: false
|
64
64
|
version_requirements: !ruby/object:Gem::Requirement
|
65
65
|
requirements:
|
66
66
|
- - "~>"
|
67
67
|
- !ruby/object:Gem::Version
|
68
|
-
version: '
|
68
|
+
version: '0.5'
|
69
69
|
- !ruby/object:Gem::Dependency
|
70
|
-
name:
|
70
|
+
name: ferret
|
71
71
|
requirement: !ruby/object:Gem::Requirement
|
72
72
|
requirements:
|
73
73
|
- - "~>"
|
74
74
|
- !ruby/object:Gem::Version
|
75
|
-
version: '
|
75
|
+
version: '0.11'
|
76
76
|
type: :runtime
|
77
77
|
prerelease: false
|
78
78
|
version_requirements: !ruby/object:Gem::Requirement
|
79
79
|
requirements:
|
80
80
|
- - "~>"
|
81
81
|
- !ruby/object:Gem::Version
|
82
|
-
version: '
|
82
|
+
version: '0.11'
|
83
83
|
- !ruby/object:Gem::Dependency
|
84
|
-
name:
|
84
|
+
name: json
|
85
85
|
requirement: !ruby/object:Gem::Requirement
|
86
86
|
requirements:
|
87
87
|
- - "~>"
|
88
88
|
- !ruby/object:Gem::Version
|
89
|
-
version: '
|
89
|
+
version: '2.1'
|
90
90
|
type: :runtime
|
91
91
|
prerelease: false
|
92
92
|
version_requirements: !ruby/object:Gem::Requirement
|
93
93
|
requirements:
|
94
94
|
- - "~>"
|
95
95
|
- !ruby/object:Gem::Version
|
96
|
-
version: '
|
96
|
+
version: '2.1'
|
97
97
|
- !ruby/object:Gem::Dependency
|
98
|
-
name:
|
98
|
+
name: naturally
|
99
99
|
requirement: !ruby/object:Gem::Requirement
|
100
100
|
requirements:
|
101
101
|
- - "~>"
|
102
102
|
- !ruby/object:Gem::Version
|
103
|
-
version: '
|
103
|
+
version: '2.1'
|
104
104
|
type: :runtime
|
105
105
|
prerelease: false
|
106
106
|
version_requirements: !ruby/object:Gem::Requirement
|
107
107
|
requirements:
|
108
108
|
- - "~>"
|
109
109
|
- !ruby/object:Gem::Version
|
110
|
-
version: '
|
110
|
+
version: '2.1'
|
111
111
|
- !ruby/object:Gem::Dependency
|
112
|
-
name:
|
112
|
+
name: puma
|
113
113
|
requirement: !ruby/object:Gem::Requirement
|
114
114
|
requirements:
|
115
115
|
- - "~>"
|
116
116
|
- !ruby/object:Gem::Version
|
117
|
-
version: '
|
117
|
+
version: '3.11'
|
118
118
|
type: :runtime
|
119
119
|
prerelease: false
|
120
120
|
version_requirements: !ruby/object:Gem::Requirement
|
121
121
|
requirements:
|
122
122
|
- - "~>"
|
123
123
|
- !ruby/object:Gem::Version
|
124
|
-
version: '
|
124
|
+
version: '3.11'
|
125
125
|
- !ruby/object:Gem::Dependency
|
126
|
-
name:
|
126
|
+
name: rack-contrib
|
127
127
|
requirement: !ruby/object:Gem::Requirement
|
128
128
|
requirements:
|
129
129
|
- - "~>"
|
130
130
|
- !ruby/object:Gem::Version
|
131
|
-
version: '0
|
131
|
+
version: '2.0'
|
132
132
|
type: :runtime
|
133
133
|
prerelease: false
|
134
134
|
version_requirements: !ruby/object:Gem::Requirement
|
135
135
|
requirements:
|
136
136
|
- - "~>"
|
137
137
|
- !ruby/object:Gem::Version
|
138
|
-
version: '0
|
138
|
+
version: '2.0'
|
139
139
|
- !ruby/object:Gem::Dependency
|
140
|
-
name:
|
140
|
+
name: requires
|
141
141
|
requirement: !ruby/object:Gem::Requirement
|
142
142
|
requirements:
|
143
143
|
- - "~>"
|
144
144
|
- !ruby/object:Gem::Version
|
145
|
-
version: '0.
|
145
|
+
version: '0.1'
|
146
146
|
type: :runtime
|
147
147
|
prerelease: false
|
148
148
|
version_requirements: !ruby/object:Gem::Requirement
|
149
149
|
requirements:
|
150
150
|
- - "~>"
|
151
151
|
- !ruby/object:Gem::Version
|
152
|
-
version: '0.
|
152
|
+
version: '0.1'
|
153
153
|
- !ruby/object:Gem::Dependency
|
154
|
-
name:
|
154
|
+
name: sass
|
155
155
|
requirement: !ruby/object:Gem::Requirement
|
156
156
|
requirements:
|
157
157
|
- - "~>"
|
158
158
|
- !ruby/object:Gem::Version
|
159
|
-
version: '3.
|
159
|
+
version: '3.4'
|
160
160
|
type: :runtime
|
161
161
|
prerelease: false
|
162
162
|
version_requirements: !ruby/object:Gem::Requirement
|
163
163
|
requirements:
|
164
164
|
- - "~>"
|
165
165
|
- !ruby/object:Gem::Version
|
166
|
-
version: '3.
|
166
|
+
version: '3.4'
|
167
167
|
- !ruby/object:Gem::Dependency
|
168
|
-
name:
|
168
|
+
name: sinatra
|
169
169
|
requirement: !ruby/object:Gem::Requirement
|
170
170
|
requirements:
|
171
171
|
- - "~>"
|
172
172
|
- !ruby/object:Gem::Version
|
173
|
-
version: '2.
|
173
|
+
version: '2.0'
|
174
174
|
type: :runtime
|
175
175
|
prerelease: false
|
176
176
|
version_requirements: !ruby/object:Gem::Requirement
|
177
177
|
requirements:
|
178
178
|
- - "~>"
|
179
179
|
- !ruby/object:Gem::Version
|
180
|
-
version: '2.
|
180
|
+
version: '2.0'
|
181
181
|
- !ruby/object:Gem::Dependency
|
182
|
-
name:
|
182
|
+
name: sinatra-contrib
|
183
183
|
requirement: !ruby/object:Gem::Requirement
|
184
184
|
requirements:
|
185
185
|
- - "~>"
|
186
186
|
- !ruby/object:Gem::Version
|
187
|
-
version: '2.
|
187
|
+
version: '2.0'
|
188
188
|
type: :runtime
|
189
189
|
prerelease: false
|
190
190
|
version_requirements: !ruby/object:Gem::Requirement
|
191
191
|
requirements:
|
192
192
|
- - "~>"
|
193
193
|
- !ruby/object:Gem::Version
|
194
|
-
version: '2.
|
194
|
+
version: '2.0'
|
195
|
+
- !ruby/object:Gem::Dependency
|
196
|
+
name: slim
|
197
|
+
requirement: !ruby/object:Gem::Requirement
|
198
|
+
requirements:
|
199
|
+
- - "~>"
|
200
|
+
- !ruby/object:Gem::Version
|
201
|
+
version: '3.0'
|
202
|
+
type: :runtime
|
203
|
+
prerelease: false
|
204
|
+
version_requirements: !ruby/object:Gem::Requirement
|
205
|
+
requirements:
|
206
|
+
- - "~>"
|
207
|
+
- !ruby/object:Gem::Version
|
208
|
+
version: '3.0'
|
195
209
|
- !ruby/object:Gem::Dependency
|
196
210
|
name: byebug
|
197
211
|
requirement: !ruby/object:Gem::Requirement
|
@@ -401,6 +415,7 @@ files:
|
|
401
415
|
- lib/madness/server_base.rb
|
402
416
|
- lib/madness/server_helper.rb
|
403
417
|
- lib/madness/settings.rb
|
418
|
+
- lib/madness/static.rb
|
404
419
|
- lib/madness/table_of_contents.rb
|
405
420
|
- lib/madness/templates/madness.yml
|
406
421
|
- lib/madness/theme.rb
|