rtfdoc 0.1.2 → 0.1.3
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile.lock +5 -5
- data/README.md +2 -1
- data/lib/rtfdoc.rb +7 -3
- data/lib/rtfdoc/cli.rb +9 -0
- data/lib/rtfdoc/generators/bootstrap.rb +1 -8
- data/lib/rtfdoc/templates/{webpack.config.js.erb → webpack.config.js} +5 -2
- data/lib/rtfdoc/version.rb +1 -1
- data/rtfdoc.gemspec +2 -2
- data/src/attributes.erb +3 -3
- data/src/css/application.scss +1 -1
- data/src/index.html.erb +2 -2
- metadata +7 -7
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 9526652b8cb796b8c425a270dbe24db31c72ac74dbc7b747dc467de1b45a9134
|
4
|
+
data.tar.gz: 8a155561cd6a0a949a872618f09ef694405e4d013fa1a6089467cc5d3f933d9f
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: c67015811940e7cda515507725424bb9c7f9fc3b4c618cc86de0232d26762c29a522cdff08cf158f924fd4c7bd2a2693c64246184120b9b6eca5b670323df73f
|
7
|
+
data.tar.gz: 3eea133c9c2f2672ae869c0afa73bdaa6c871cc012bbb9576f4e554d35080c1069163abad49c572c568607bb8bafa2d0b7e5c51711dc70219b34a1bdf8cf0b46
|
data/Gemfile.lock
CHANGED
@@ -1,10 +1,10 @@
|
|
1
1
|
PATH
|
2
2
|
remote: .
|
3
3
|
specs:
|
4
|
-
rtfdoc (0.1.
|
4
|
+
rtfdoc (0.1.3)
|
5
5
|
erubi (~> 1.9.0)
|
6
6
|
redcarpet (~> 3.5.0)
|
7
|
-
rouge (~> 3.
|
7
|
+
rouge (~> 3.22.0)
|
8
8
|
thor (~> 1.0.1)
|
9
9
|
|
10
10
|
GEM
|
@@ -17,11 +17,11 @@ GEM
|
|
17
17
|
irb (1.2.4)
|
18
18
|
reline (>= 0.0.1)
|
19
19
|
minitest (5.14.1)
|
20
|
-
rake (
|
20
|
+
rake (13.0.1)
|
21
21
|
redcarpet (3.5.0)
|
22
22
|
reline (0.1.4)
|
23
23
|
io-console (~> 0.5)
|
24
|
-
rouge (3.
|
24
|
+
rouge (3.22.0)
|
25
25
|
thor (1.0.1)
|
26
26
|
|
27
27
|
PLATFORMS
|
@@ -33,7 +33,7 @@ DEPENDENCIES
|
|
33
33
|
byebug
|
34
34
|
irb
|
35
35
|
minitest (~> 5.0)
|
36
|
-
rake (~>
|
36
|
+
rake (~> 13.0)
|
37
37
|
rtfdoc!
|
38
38
|
|
39
39
|
BUNDLED WITH
|
data/README.md
CHANGED
@@ -14,7 +14,8 @@ $ gem install rtfdoc
|
|
14
14
|
|
15
15
|
You can scaffold a new project using `rtfdoc bootstrap <project_name>`. It will create a skeleton for your project, and generate needed configuration files.
|
16
16
|
|
17
|
-
Once in your project directory, you can install ruby dependencies using `bundle install` and javascript dependencies using `yarn install`.
|
17
|
+
Once in your project directory, you can install ruby dependencies using `bundle install` and javascript dependencies using `yarn install`. Then we want to stub the binary by running `bundle binstubs bundler rtfdoc`.
|
18
|
+
And finally, you'll copy the assets source by running `bin/rtfdoc install`.
|
18
19
|
|
19
20
|
By convention, you should put your documentation content under the `content/` directory. If you don't follow this convention, don't forget to modify the configuration file as well.
|
20
21
|
|
data/lib/rtfdoc.rb
CHANGED
@@ -111,9 +111,13 @@ module RTFDoc
|
|
111
111
|
end
|
112
112
|
|
113
113
|
class Template
|
114
|
-
|
115
|
-
|
114
|
+
attr_reader :app_name, :page_title
|
115
|
+
|
116
|
+
def initialize(sections, config)
|
117
|
+
@content = sections.map(&:output).join
|
116
118
|
@menu_content = sections.map(&:menu_output).join
|
119
|
+
@app_name = config['app_name']
|
120
|
+
@page_title = config['title']
|
117
121
|
end
|
118
122
|
|
119
123
|
def output
|
@@ -335,7 +339,7 @@ module RTFDoc
|
|
335
339
|
end
|
336
340
|
|
337
341
|
out = File.new("#{Dir.tmpdir}/rtfdoc_output.html", 'w')
|
338
|
-
out.write(Template.new(nodes).output)
|
342
|
+
out.write(Template.new(nodes, config).output)
|
339
343
|
out.close
|
340
344
|
end
|
341
345
|
|
data/lib/rtfdoc/cli.rb
CHANGED
@@ -3,6 +3,8 @@ require 'rtfdoc/generators/bootstrap'
|
|
3
3
|
|
4
4
|
module RTFDoc
|
5
5
|
class CLI < Thor
|
6
|
+
include Thor::Actions
|
7
|
+
|
6
8
|
def self.exit_on_failure?
|
7
9
|
true
|
8
10
|
end
|
@@ -14,5 +16,12 @@ module RTFDoc
|
|
14
16
|
def convert
|
15
17
|
::RTFDoc::Generator.new(options[:config]).run
|
16
18
|
end
|
19
|
+
|
20
|
+
source_root(File.expand_path('../../', __dir__))
|
21
|
+
|
22
|
+
desc 'install', 'Copy the latest version of the assets source in your project'
|
23
|
+
def install
|
24
|
+
directory 'src', 'src', exclude_pattern: /\.erb\Z/
|
25
|
+
end
|
17
26
|
end
|
18
27
|
end
|
@@ -25,18 +25,11 @@ module RTFDoc
|
|
25
25
|
|
26
26
|
def create_webpack_config
|
27
27
|
template('package.json.erb', "#{name}/package.json")
|
28
|
-
|
28
|
+
copy_file('webpack.config.js', "#{name}/webpack.config.js")
|
29
29
|
end
|
30
30
|
|
31
31
|
def create_config
|
32
32
|
template('config.yml.erb', "#{name}/config.yml")
|
33
33
|
end
|
34
|
-
|
35
|
-
private
|
36
|
-
|
37
|
-
def gem_dir
|
38
|
-
File.expand_path('../../../', __dir__)
|
39
|
-
end
|
40
|
-
|
41
34
|
end
|
42
35
|
end
|
@@ -8,13 +8,13 @@ const devMode = process.env.NODE_ENV != 'production'
|
|
8
8
|
|
9
9
|
module.exports = {
|
10
10
|
mode: devMode ? "development" : "production",
|
11
|
-
entry:
|
11
|
+
entry: __dirname + "/src/js/index.js",
|
12
12
|
output: {
|
13
13
|
filename: devMode ? "main.js" : "main.[contenthash].js",
|
14
14
|
path: __dirname + "/dist",
|
15
15
|
},
|
16
16
|
plugins: [
|
17
|
-
new CleanWebpackPlugin(),
|
17
|
+
new CleanWebpackPlugin({ cleanStaleWebpackAssets: !devMode }),
|
18
18
|
new MiniCssExtractPlugin({
|
19
19
|
filename: devMode ? '[name].css' : '[name].[contenthash].css'
|
20
20
|
}),
|
@@ -23,6 +23,9 @@ module.exports = {
|
|
23
23
|
})
|
24
24
|
],
|
25
25
|
devtool: devMode ? "inline-source-map" : "source-map",
|
26
|
+
resolve: {
|
27
|
+
modules: [path.resolve(__dirname, 'node_modules')]
|
28
|
+
},
|
26
29
|
module: {
|
27
30
|
rules: [
|
28
31
|
{
|
data/lib/rtfdoc/version.rb
CHANGED
data/rtfdoc.gemspec
CHANGED
@@ -37,11 +37,11 @@ Gem::Specification.new do |spec|
|
|
37
37
|
spec.require_paths = ["lib"]
|
38
38
|
|
39
39
|
spec.add_dependency "erubi", "~> 1.9.0"
|
40
|
-
spec.add_dependency "rouge", "~> 3.
|
40
|
+
spec.add_dependency "rouge", "~> 3.22.0"
|
41
41
|
spec.add_dependency "redcarpet", "~> 3.5.0"
|
42
42
|
spec.add_dependency "thor", "~> 1.0.1"
|
43
43
|
|
44
44
|
spec.add_development_dependency "bundler", "~> 1.17"
|
45
|
-
spec.add_development_dependency "rake", "~>
|
45
|
+
spec.add_development_dependency "rake", "~> 13.0"
|
46
46
|
spec.add_development_dependency "minitest", "~> 5.0"
|
47
47
|
end
|
data/src/attributes.erb
CHANGED
@@ -30,11 +30,11 @@
|
|
30
30
|
<% hash['children'].each do |child_name, child_hash| %>
|
31
31
|
<li class="list-item">
|
32
32
|
<div class="list-item-label">
|
33
|
-
<div class="list-item-name"><%=
|
34
|
-
<div class="list-item-type"><%=
|
33
|
+
<div class="list-item-name"><%= child_name %></div>
|
34
|
+
<div class="list-item-type"><%= child_hash['type'] %> </div>
|
35
35
|
</div>
|
36
36
|
<div class="list-item-description">
|
37
|
-
<p><%=
|
37
|
+
<p><%= child_hash['desc'] %></p>
|
38
38
|
</div>
|
39
39
|
</li>
|
40
40
|
<% end %>
|
data/src/css/application.scss
CHANGED
@@ -544,7 +544,7 @@ p code {
|
|
544
544
|
border: 1px solid var(--inline-code-border);
|
545
545
|
padding: 2px 3px 0;
|
546
546
|
margin: 0 1px;
|
547
|
-
font-size:
|
547
|
+
font-size: var(--code-font-size);
|
548
548
|
font-family: var(--monospace-font);
|
549
549
|
font-weight: 500;
|
550
550
|
background: var(--inline-code-background); }
|
data/src/index.html.erb
CHANGED
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
4
|
<head>
|
5
5
|
<meta charset="utf-8">
|
6
|
-
<title
|
6
|
+
<title><%= page_title %></title>
|
7
7
|
<meta name="description" content="">
|
8
8
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
9
9
|
</head>
|
@@ -11,7 +11,7 @@
|
|
11
11
|
<div id="sidebar" class="sidebar">
|
12
12
|
<div class="sidebar-header">
|
13
13
|
<div class="sidebar-title">
|
14
|
-
|
14
|
+
<%= app_name %> <span class="api">api</span>
|
15
15
|
</div>
|
16
16
|
<div class="theme-switch-wrapper">
|
17
17
|
<div class="theme-switch">
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: rtfdoc
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.1.
|
4
|
+
version: 0.1.3
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- ccocchi
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2020-08-
|
11
|
+
date: 2020-08-17 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: erubi
|
@@ -30,14 +30,14 @@ dependencies:
|
|
30
30
|
requirements:
|
31
31
|
- - "~>"
|
32
32
|
- !ruby/object:Gem::Version
|
33
|
-
version: 3.
|
33
|
+
version: 3.22.0
|
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: 3.
|
40
|
+
version: 3.22.0
|
41
41
|
- !ruby/object:Gem::Dependency
|
42
42
|
name: redcarpet
|
43
43
|
requirement: !ruby/object:Gem::Requirement
|
@@ -86,14 +86,14 @@ dependencies:
|
|
86
86
|
requirements:
|
87
87
|
- - "~>"
|
88
88
|
- !ruby/object:Gem::Version
|
89
|
-
version: '
|
89
|
+
version: '13.0'
|
90
90
|
type: :development
|
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: '13.0'
|
97
97
|
- !ruby/object:Gem::Dependency
|
98
98
|
name: minitest
|
99
99
|
requirement: !ruby/object:Gem::Requirement
|
@@ -132,7 +132,7 @@ files:
|
|
132
132
|
- lib/rtfdoc/templates/config.yml.erb
|
133
133
|
- lib/rtfdoc/templates/gitignore
|
134
134
|
- lib/rtfdoc/templates/package.json.erb
|
135
|
-
- lib/rtfdoc/templates/webpack.config.js
|
135
|
+
- lib/rtfdoc/templates/webpack.config.js
|
136
136
|
- lib/rtfdoc/version.rb
|
137
137
|
- rtfdoc.gemspec
|
138
138
|
- src/attributes.erb
|