graphql-docs 0.1.0 → 0.1.1
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.
- checksums.yaml +4 -4
- data/.gitignore +2 -0
- data/README.md +75 -15
- data/Rakefile +28 -0
- data/graphql-docs.gemspec +3 -3
- data/lib/graphql-docs.rb +3 -2
- data/lib/graphql-docs/configuration.rb +6 -2
- data/lib/graphql-docs/generator.rb +10 -35
- data/lib/graphql-docs/helpers.rb +74 -0
- data/lib/graphql-docs/layouts/default.html +39 -0
- data/lib/graphql-docs/layouts/includes/sidebar.html +127 -0
- data/lib/graphql-docs/parser.rb +3 -0
- data/lib/graphql-docs/renderer.rb +13 -4
- data/lib/graphql-docs/version.rb +1 -1
- data/sample_assets/_sass/_api-box.scss +75 -0
- data/sample_assets/_sass/_content.scss +497 -0
- data/sample_assets/_sass/_fonts.scss +21 -0
- data/sample_assets/_sass/_header.scss +59 -0
- data/sample_assets/_sass/_mobile.scss +92 -0
- data/sample_assets/_sass/_normalize.scss +127 -0
- data/sample_assets/_sass/_search.scss +34 -0
- data/sample_assets/_sass/_sidebar.scss +81 -0
- data/sample_assets/_sass/_syntax.scss +291 -0
- data/sample_assets/_sass/_types.scss +0 -0
- data/sample_assets/_sass/screen.scss +647 -0
- data/sample_assets/css/screen.scss +48 -0
- metadata +39 -25
- data/lib/graphql-docs/generator/helpers.rb +0 -46
@@ -0,0 +1,48 @@
|
|
1
|
+
@charset "utf-8";
|
2
|
+
|
3
|
+
@import "../_sass/_normalize.scss";
|
4
|
+
@import "../_sass/_fonts";
|
5
|
+
|
6
|
+
body {
|
7
|
+
font-family: 'Source Sans Pro', 'Helvetica Neue', Helvetica, Arial, sans-serif;
|
8
|
+
-webkit-font-smoothing: antialiased;
|
9
|
+
-moz-osx-font-smoothing: grayscale;
|
10
|
+
font-size: 16px;
|
11
|
+
font-weight: 400;
|
12
|
+
color: #444;
|
13
|
+
}
|
14
|
+
h1,
|
15
|
+
h2,
|
16
|
+
h3,
|
17
|
+
h4,
|
18
|
+
h5,
|
19
|
+
h6 {
|
20
|
+
font-family: 'ProximaNova-Semibold';
|
21
|
+
font-weight: 200;
|
22
|
+
}
|
23
|
+
em {
|
24
|
+
font-style: italic;
|
25
|
+
}
|
26
|
+
|
27
|
+
#wrap {
|
28
|
+
padding-top: 100px;
|
29
|
+
padding-left: 300px;
|
30
|
+
height: 100%;
|
31
|
+
}
|
32
|
+
#header {
|
33
|
+
position: fixed;
|
34
|
+
z-index: 2;
|
35
|
+
top: 0;
|
36
|
+
left: 0;
|
37
|
+
width: 100%;
|
38
|
+
height: 100px;
|
39
|
+
font-family: 'ProximaNova-Semibold';
|
40
|
+
}
|
41
|
+
|
42
|
+
@import '../_sass/_header';
|
43
|
+
@import '../_sass/_sidebar';
|
44
|
+
@import '../_sass/_content';
|
45
|
+
@import '../_sass/_types';
|
46
|
+
@import '../_sass/_mobile';
|
47
|
+
@import '../_sass/_api-box';
|
48
|
+
@import '../_sass/_syntax';
|
metadata
CHANGED
@@ -1,29 +1,29 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: graphql-docs
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.1.
|
4
|
+
version: 0.1.1
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Garen Torikian
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2017-02-
|
11
|
+
date: 2017-02-17 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: faraday
|
15
15
|
requirement: !ruby/object:Gem::Requirement
|
16
16
|
requirements:
|
17
|
-
- - "
|
17
|
+
- - "<"
|
18
18
|
- !ruby/object:Gem::Version
|
19
|
-
version: '0.
|
19
|
+
version: '0.10'
|
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: '0.
|
26
|
+
version: '0.10'
|
27
27
|
- !ruby/object:Gem::Dependency
|
28
28
|
name: graphql
|
29
29
|
requirement: !ruby/object:Gem::Requirement
|
@@ -42,16 +42,16 @@ dependencies:
|
|
42
42
|
name: html-pipeline
|
43
43
|
requirement: !ruby/object:Gem::Requirement
|
44
44
|
requirements:
|
45
|
-
- -
|
45
|
+
- - "~>"
|
46
46
|
- !ruby/object:Gem::Version
|
47
|
-
version: 2.
|
47
|
+
version: '2.2'
|
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: 2.
|
54
|
+
version: '2.2'
|
55
55
|
- !ruby/object:Gem::Dependency
|
56
56
|
name: github-markdown
|
57
57
|
requirement: !ruby/object:Gem::Requirement
|
@@ -94,20 +94,6 @@ dependencies:
|
|
94
94
|
- - '='
|
95
95
|
- !ruby/object:Gem::Version
|
96
96
|
version: 2.1.0
|
97
|
-
- !ruby/object:Gem::Dependency
|
98
|
-
name: page-toc-filter
|
99
|
-
requirement: !ruby/object:Gem::Requirement
|
100
|
-
requirements:
|
101
|
-
- - "~>"
|
102
|
-
- !ruby/object:Gem::Version
|
103
|
-
version: 0.0.1
|
104
|
-
type: :runtime
|
105
|
-
prerelease: false
|
106
|
-
version_requirements: !ruby/object:Gem::Requirement
|
107
|
-
requirements:
|
108
|
-
- - "~>"
|
109
|
-
- !ruby/object:Gem::Version
|
110
|
-
version: 0.0.1
|
111
97
|
- !ruby/object:Gem::Dependency
|
112
98
|
name: awesome_print
|
113
99
|
requirement: !ruby/object:Gem::Requirement
|
@@ -206,6 +192,20 @@ dependencies:
|
|
206
192
|
- - ">="
|
207
193
|
- !ruby/object:Gem::Version
|
208
194
|
version: '0'
|
195
|
+
- !ruby/object:Gem::Dependency
|
196
|
+
name: sass
|
197
|
+
requirement: !ruby/object:Gem::Requirement
|
198
|
+
requirements:
|
199
|
+
- - "~>"
|
200
|
+
- !ruby/object:Gem::Version
|
201
|
+
version: '3.4'
|
202
|
+
type: :development
|
203
|
+
prerelease: false
|
204
|
+
version_requirements: !ruby/object:Gem::Requirement
|
205
|
+
requirements:
|
206
|
+
- - "~>"
|
207
|
+
- !ruby/object:Gem::Version
|
208
|
+
version: '3.4'
|
209
209
|
- !ruby/object:Gem::Dependency
|
210
210
|
name: webmock
|
211
211
|
requirement: !ruby/object:Gem::Requirement
|
@@ -239,7 +239,8 @@ files:
|
|
239
239
|
- lib/graphql-docs/client.rb
|
240
240
|
- lib/graphql-docs/configuration.rb
|
241
241
|
- lib/graphql-docs/generator.rb
|
242
|
-
- lib/graphql-docs/
|
242
|
+
- lib/graphql-docs/helpers.rb
|
243
|
+
- lib/graphql-docs/layouts/default.html
|
243
244
|
- lib/graphql-docs/layouts/graphql_enums.html
|
244
245
|
- lib/graphql-docs/layouts/graphql_input_objects.html
|
245
246
|
- lib/graphql-docs/layouts/graphql_interfaces.html
|
@@ -252,10 +253,23 @@ files:
|
|
252
253
|
- lib/graphql-docs/layouts/includes/fields.html
|
253
254
|
- lib/graphql-docs/layouts/includes/input_fields.html
|
254
255
|
- lib/graphql-docs/layouts/includes/possible_types.html
|
256
|
+
- lib/graphql-docs/layouts/includes/sidebar.html
|
255
257
|
- lib/graphql-docs/layouts/includes/values.html
|
256
258
|
- lib/graphql-docs/parser.rb
|
257
259
|
- lib/graphql-docs/renderer.rb
|
258
260
|
- lib/graphql-docs/version.rb
|
261
|
+
- sample_assets/_sass/_api-box.scss
|
262
|
+
- sample_assets/_sass/_content.scss
|
263
|
+
- sample_assets/_sass/_fonts.scss
|
264
|
+
- sample_assets/_sass/_header.scss
|
265
|
+
- sample_assets/_sass/_mobile.scss
|
266
|
+
- sample_assets/_sass/_normalize.scss
|
267
|
+
- sample_assets/_sass/_search.scss
|
268
|
+
- sample_assets/_sass/_sidebar.scss
|
269
|
+
- sample_assets/_sass/_syntax.scss
|
270
|
+
- sample_assets/_sass/_types.scss
|
271
|
+
- sample_assets/_sass/screen.scss
|
272
|
+
- sample_assets/css/screen.scss
|
259
273
|
- script/bootstrap
|
260
274
|
- script/console
|
261
275
|
homepage: https://github.com/gjtorikian/graphql-docs
|
@@ -1,46 +0,0 @@
|
|
1
|
-
module GraphQLDocs
|
2
|
-
class Generator
|
3
|
-
module Helpers
|
4
|
-
SLUGIFY_PRETTY_REGEXP = Regexp.new("[^[:alnum:]._~!$&'()+,;=@]+").freeze
|
5
|
-
|
6
|
-
attr_accessor :templates
|
7
|
-
|
8
|
-
def slugify(str)
|
9
|
-
slug = str.gsub(SLUGIFY_PRETTY_REGEXP, '-')
|
10
|
-
slug.gsub!(%r!^\-|\-$!i, '')
|
11
|
-
slug.downcase
|
12
|
-
end
|
13
|
-
|
14
|
-
def include(filename, opts)
|
15
|
-
template = fetch_include(filename)
|
16
|
-
template.result(OpenStruct.new(opts.merge(helper_methods)).instance_eval { binding })
|
17
|
-
end
|
18
|
-
|
19
|
-
def fetch_include(filename)
|
20
|
-
@templates ||= {}
|
21
|
-
|
22
|
-
return @templates[filename] unless @templates[filename].nil?
|
23
|
-
|
24
|
-
@templates[filename] = ERB.new(File.read(File.join(@options[:templates][:includes], filename)))
|
25
|
-
@templates[filename]
|
26
|
-
end
|
27
|
-
|
28
|
-
def markdown(string)
|
29
|
-
GitHub::Markdown.render(string || 'n/a')
|
30
|
-
end
|
31
|
-
|
32
|
-
def helper_methods
|
33
|
-
return @helper_methods if defined?(@helper_methods)
|
34
|
-
|
35
|
-
@helper_methods = {}
|
36
|
-
|
37
|
-
Helpers.instance_methods.each do |name|
|
38
|
-
next if name == :helper_methods
|
39
|
-
@helper_methods[name] = method(name)
|
40
|
-
end
|
41
|
-
|
42
|
-
@helper_methods
|
43
|
-
end
|
44
|
-
end
|
45
|
-
end
|
46
|
-
end
|