panko_serializer 0.8.2 → 0.8.3
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/.github/dependabot.yml +6 -0
- data/.github/workflows/docs.yml +4 -4
- data/.github/workflows/lint.yml +8 -14
- data/.github/workflows/ruby.yml +11 -7
- data/.gitignore +2 -0
- data/.rubocop.yml +29 -21
- data/Appraisals +20 -8
- data/Gemfile +11 -3
- data/README.md +3 -3
- data/Rakefile +3 -1
- data/benchmarks/allocs.rb +2 -2
- data/benchmarks/benchmarking_support.rb +2 -1
- data/benchmarks/bm_ams_0_10.rb +3 -7
- data/benchmarks/bm_panko_json.rb +2 -6
- data/benchmarks/bm_panko_object.rb +2 -6
- data/benchmarks/bm_plain_object.rb +1 -4
- data/benchmarks/bm_serialization_descriptor.rb +1 -1
- data/benchmarks/bm_to_object.rb +2 -6
- data/benchmarks/profile.rb +2 -2
- data/benchmarks/sanity.rb +2 -6
- data/benchmarks/setup.rb +4 -3
- data/benchmarks/type_casts/support.rb +0 -1
- data/docs/docs/associations.md +19 -6
- data/docs/docs/attributes.md +29 -23
- data/docs/docs/design-choices.md +28 -27
- data/docs/docs/getting-started.md +9 -3
- data/docs/docs/introduction.md +5 -5
- data/docs/docs/performance.md +0 -1
- data/docs/docs/response-bag.md +8 -1
- data/docs/docusaurus.config.js +86 -0
- data/docs/package-lock.json +12607 -18674
- data/docs/package.json +14 -7
- data/docs/src/css/customTheme.css +9 -0
- data/docs/static/CNAME +1 -0
- data/ext/panko_serializer/attributes_writer/active_record.c +103 -72
- data/ext/panko_serializer/attributes_writer/active_record.h +2 -0
- data/gemfiles/7.0.0.gemfile +12 -3
- data/gemfiles/7.0.0.gemfile.lock +62 -50
- data/gemfiles/7.1.0.gemfile +15 -6
- data/gemfiles/7.1.0.gemfile.lock +76 -59
- data/gemfiles/{6.1.0.gemfile → 7.2.0.gemfile} +15 -6
- data/gemfiles/{6.1.0.gemfile.lock → 7.2.0.gemfile.lock} +97 -65
- data/gemfiles/8.0.0.gemfile +39 -0
- data/gemfiles/8.0.0.gemfile.lock +219 -0
- data/lib/panko/version.rb +1 -1
- data/panko_serializer.gemspec +1 -1
- metadata +12 -12
- data/.standard.yml +0 -5
- data/docs/.DS_Store +0 -0
- data/docs/README.md +0 -198
- data/docs/core/Footer.js +0 -80
- data/docs/i18n/en.json +0 -50
- data/docs/siteConfig.js +0 -80
|
@@ -0,0 +1,219 @@
|
|
|
1
|
+
PATH
|
|
2
|
+
remote: ..
|
|
3
|
+
specs:
|
|
4
|
+
panko_serializer (0.8.3)
|
|
5
|
+
activesupport
|
|
6
|
+
oj (> 3.11.0, < 4.0.0)
|
|
7
|
+
|
|
8
|
+
GEM
|
|
9
|
+
remote: https://rubygems.org/
|
|
10
|
+
specs:
|
|
11
|
+
actionpack (8.0.1)
|
|
12
|
+
actionview (= 8.0.1)
|
|
13
|
+
activesupport (= 8.0.1)
|
|
14
|
+
nokogiri (>= 1.8.5)
|
|
15
|
+
rack (>= 2.2.4)
|
|
16
|
+
rack-session (>= 1.0.1)
|
|
17
|
+
rack-test (>= 0.6.3)
|
|
18
|
+
rails-dom-testing (~> 2.2)
|
|
19
|
+
rails-html-sanitizer (~> 1.6)
|
|
20
|
+
useragent (~> 0.16)
|
|
21
|
+
actionview (8.0.1)
|
|
22
|
+
activesupport (= 8.0.1)
|
|
23
|
+
builder (~> 3.1)
|
|
24
|
+
erubi (~> 1.11)
|
|
25
|
+
rails-dom-testing (~> 2.2)
|
|
26
|
+
rails-html-sanitizer (~> 1.6)
|
|
27
|
+
active_model_serializers (0.10.14)
|
|
28
|
+
actionpack (>= 4.1)
|
|
29
|
+
activemodel (>= 4.1)
|
|
30
|
+
case_transform (>= 0.2)
|
|
31
|
+
jsonapi-renderer (>= 0.1.1.beta1, < 0.3)
|
|
32
|
+
activemodel (8.0.1)
|
|
33
|
+
activesupport (= 8.0.1)
|
|
34
|
+
activerecord (8.0.1)
|
|
35
|
+
activemodel (= 8.0.1)
|
|
36
|
+
activesupport (= 8.0.1)
|
|
37
|
+
timeout (>= 0.4.0)
|
|
38
|
+
activesupport (8.0.1)
|
|
39
|
+
base64
|
|
40
|
+
benchmark (>= 0.3)
|
|
41
|
+
bigdecimal
|
|
42
|
+
concurrent-ruby (~> 1.0, >= 1.3.1)
|
|
43
|
+
connection_pool (>= 2.2.5)
|
|
44
|
+
drb
|
|
45
|
+
i18n (>= 1.6, < 2)
|
|
46
|
+
logger (>= 1.4.2)
|
|
47
|
+
minitest (>= 5.1)
|
|
48
|
+
securerandom (>= 0.3)
|
|
49
|
+
tzinfo (~> 2.0, >= 2.0.5)
|
|
50
|
+
uri (>= 0.13.1)
|
|
51
|
+
appraisal (2.5.0)
|
|
52
|
+
bundler
|
|
53
|
+
rake
|
|
54
|
+
thor (>= 0.14.0)
|
|
55
|
+
ast (2.4.2)
|
|
56
|
+
base64 (0.2.0)
|
|
57
|
+
benchmark (0.4.0)
|
|
58
|
+
benchmark-ips (2.14.0)
|
|
59
|
+
bigdecimal (3.1.8)
|
|
60
|
+
builder (3.3.0)
|
|
61
|
+
byebug (11.1.3)
|
|
62
|
+
case_transform (0.2)
|
|
63
|
+
activesupport
|
|
64
|
+
concurrent-ruby (1.3.4)
|
|
65
|
+
connection_pool (2.4.1)
|
|
66
|
+
crass (1.0.6)
|
|
67
|
+
diff-lcs (1.5.1)
|
|
68
|
+
drb (2.2.1)
|
|
69
|
+
erubi (1.13.0)
|
|
70
|
+
faker (3.5.1)
|
|
71
|
+
i18n (>= 1.8.11, < 2)
|
|
72
|
+
i18n (1.14.6)
|
|
73
|
+
concurrent-ruby (~> 1.0)
|
|
74
|
+
json (2.7.5)
|
|
75
|
+
jsonapi-renderer (0.2.2)
|
|
76
|
+
language_server-protocol (3.17.0.3)
|
|
77
|
+
lint_roller (1.1.0)
|
|
78
|
+
logger (1.6.3)
|
|
79
|
+
loofah (2.22.0)
|
|
80
|
+
crass (~> 1.0.2)
|
|
81
|
+
nokogiri (>= 1.12.0)
|
|
82
|
+
memory_profiler (1.1.0)
|
|
83
|
+
minitest (5.25.4)
|
|
84
|
+
nokogiri (1.16.7-aarch64-linux)
|
|
85
|
+
racc (~> 1.4)
|
|
86
|
+
nokogiri (1.16.7-arm-linux)
|
|
87
|
+
racc (~> 1.4)
|
|
88
|
+
nokogiri (1.16.7-arm64-darwin)
|
|
89
|
+
racc (~> 1.4)
|
|
90
|
+
nokogiri (1.16.7-x86-linux)
|
|
91
|
+
racc (~> 1.4)
|
|
92
|
+
nokogiri (1.16.7-x86_64-darwin)
|
|
93
|
+
racc (~> 1.4)
|
|
94
|
+
nokogiri (1.16.7-x86_64-linux)
|
|
95
|
+
racc (~> 1.4)
|
|
96
|
+
oj (3.16.7)
|
|
97
|
+
bigdecimal (>= 3.0)
|
|
98
|
+
ostruct (>= 0.2)
|
|
99
|
+
ostruct (0.6.0)
|
|
100
|
+
parallel (1.26.3)
|
|
101
|
+
parser (3.3.5.1)
|
|
102
|
+
ast (~> 2.4.1)
|
|
103
|
+
racc
|
|
104
|
+
pg (1.5.9)
|
|
105
|
+
racc (1.8.1)
|
|
106
|
+
rack (3.1.8)
|
|
107
|
+
rack-session (2.0.0)
|
|
108
|
+
rack (>= 3.0.0)
|
|
109
|
+
rack-test (2.1.0)
|
|
110
|
+
rack (>= 1.3)
|
|
111
|
+
rails-dom-testing (2.2.0)
|
|
112
|
+
activesupport (>= 5.0.0)
|
|
113
|
+
minitest
|
|
114
|
+
nokogiri (>= 1.6)
|
|
115
|
+
rails-html-sanitizer (1.6.0)
|
|
116
|
+
loofah (~> 2.21)
|
|
117
|
+
nokogiri (~> 1.14)
|
|
118
|
+
rainbow (3.1.1)
|
|
119
|
+
rake (13.2.1)
|
|
120
|
+
rake-compiler (1.2.8)
|
|
121
|
+
rake
|
|
122
|
+
regexp_parser (2.9.2)
|
|
123
|
+
rspec (3.13.0)
|
|
124
|
+
rspec-core (~> 3.13.0)
|
|
125
|
+
rspec-expectations (~> 3.13.0)
|
|
126
|
+
rspec-mocks (~> 3.13.0)
|
|
127
|
+
rspec-core (3.13.2)
|
|
128
|
+
rspec-support (~> 3.13.0)
|
|
129
|
+
rspec-expectations (3.13.3)
|
|
130
|
+
diff-lcs (>= 1.2.0, < 2.0)
|
|
131
|
+
rspec-support (~> 3.13.0)
|
|
132
|
+
rspec-mocks (3.13.2)
|
|
133
|
+
diff-lcs (>= 1.2.0, < 2.0)
|
|
134
|
+
rspec-support (~> 3.13.0)
|
|
135
|
+
rspec-support (3.13.1)
|
|
136
|
+
rubocop (1.66.1)
|
|
137
|
+
json (~> 2.3)
|
|
138
|
+
language_server-protocol (>= 3.17.0)
|
|
139
|
+
parallel (~> 1.10)
|
|
140
|
+
parser (>= 3.3.0.2)
|
|
141
|
+
rainbow (>= 2.2.2, < 4.0)
|
|
142
|
+
regexp_parser (>= 2.4, < 3.0)
|
|
143
|
+
rubocop-ast (>= 1.32.2, < 2.0)
|
|
144
|
+
ruby-progressbar (~> 1.7)
|
|
145
|
+
unicode-display_width (>= 2.4.0, < 3.0)
|
|
146
|
+
rubocop-ast (1.33.0)
|
|
147
|
+
parser (>= 3.3.1.0)
|
|
148
|
+
rubocop-performance (1.22.1)
|
|
149
|
+
rubocop (>= 1.48.1, < 2.0)
|
|
150
|
+
rubocop-ast (>= 1.31.1, < 2.0)
|
|
151
|
+
rubocop-rspec (3.2.0)
|
|
152
|
+
rubocop (~> 1.61)
|
|
153
|
+
ruby-progressbar (1.13.0)
|
|
154
|
+
securerandom (0.4.0)
|
|
155
|
+
sqlite3 (2.2.0-aarch64-linux-gnu)
|
|
156
|
+
sqlite3 (2.2.0-arm-linux-gnu)
|
|
157
|
+
sqlite3 (2.2.0-arm64-darwin)
|
|
158
|
+
sqlite3 (2.2.0-x86-linux-gnu)
|
|
159
|
+
sqlite3 (2.2.0-x86_64-darwin)
|
|
160
|
+
sqlite3 (2.2.0-x86_64-linux-gnu)
|
|
161
|
+
stackprof (0.2.26)
|
|
162
|
+
standard (1.41.1)
|
|
163
|
+
language_server-protocol (~> 3.17.0.2)
|
|
164
|
+
lint_roller (~> 1.0)
|
|
165
|
+
rubocop (~> 1.66.0)
|
|
166
|
+
standard-custom (~> 1.0.0)
|
|
167
|
+
standard-performance (~> 1.5)
|
|
168
|
+
standard-custom (1.0.2)
|
|
169
|
+
lint_roller (~> 1.0)
|
|
170
|
+
rubocop (~> 1.50)
|
|
171
|
+
standard-performance (1.5.0)
|
|
172
|
+
lint_roller (~> 1.1)
|
|
173
|
+
rubocop-performance (~> 1.22.0)
|
|
174
|
+
terminal-table (3.0.2)
|
|
175
|
+
unicode-display_width (>= 1.1.1, < 3)
|
|
176
|
+
thor (1.3.2)
|
|
177
|
+
timeout (0.4.2)
|
|
178
|
+
tzinfo (2.0.6)
|
|
179
|
+
concurrent-ruby (~> 1.0)
|
|
180
|
+
unicode-display_width (2.6.0)
|
|
181
|
+
uri (1.0.2)
|
|
182
|
+
useragent (0.16.10)
|
|
183
|
+
vernier (1.3.0)
|
|
184
|
+
|
|
185
|
+
PLATFORMS
|
|
186
|
+
aarch64-linux
|
|
187
|
+
arm-linux
|
|
188
|
+
arm64-darwin
|
|
189
|
+
x86-linux
|
|
190
|
+
x86_64-darwin
|
|
191
|
+
x86_64-linux
|
|
192
|
+
|
|
193
|
+
DEPENDENCIES
|
|
194
|
+
active_model_serializers (~> 0.10)
|
|
195
|
+
activemodel (~> 8.0.0)
|
|
196
|
+
activerecord (~> 8.0.0)
|
|
197
|
+
activesupport (~> 8.0.0)
|
|
198
|
+
appraisal
|
|
199
|
+
benchmark-ips
|
|
200
|
+
byebug
|
|
201
|
+
faker
|
|
202
|
+
memory_profiler
|
|
203
|
+
panko_serializer!
|
|
204
|
+
pg
|
|
205
|
+
rake
|
|
206
|
+
rake-compiler
|
|
207
|
+
rspec (~> 3.0)
|
|
208
|
+
rubocop
|
|
209
|
+
rubocop-performance
|
|
210
|
+
rubocop-rspec
|
|
211
|
+
sqlite3 (>= 2.1)
|
|
212
|
+
stackprof
|
|
213
|
+
standard
|
|
214
|
+
standard-performance
|
|
215
|
+
terminal-table
|
|
216
|
+
vernier
|
|
217
|
+
|
|
218
|
+
BUNDLED WITH
|
|
219
|
+
2.5.21
|
data/lib/panko/version.rb
CHANGED
data/panko_serializer.gemspec
CHANGED
|
@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
|
|
|
21
21
|
"changelog_uri" => "https://github.com/yosiat/panko_serializer/releases"
|
|
22
22
|
}
|
|
23
23
|
|
|
24
|
-
spec.required_ruby_version = ">=
|
|
24
|
+
spec.required_ruby_version = ">= 3.1.0"
|
|
25
25
|
|
|
26
26
|
spec.files = `git ls-files -z`.split("\x0").reject do |f|
|
|
27
27
|
f.match(%r{^(test|spec|features)/})
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: panko_serializer
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.8.
|
|
4
|
+
version: 0.8.3
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Yosi Attias
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2024-
|
|
11
|
+
date: 2024-12-15 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: oj
|
|
@@ -67,13 +67,13 @@ extensions:
|
|
|
67
67
|
extra_rdoc_files: []
|
|
68
68
|
files:
|
|
69
69
|
- ".clang-format"
|
|
70
|
+
- ".github/dependabot.yml"
|
|
70
71
|
- ".github/workflows/docs.yml"
|
|
71
72
|
- ".github/workflows/lint.yml"
|
|
72
73
|
- ".github/workflows/ruby.yml"
|
|
73
74
|
- ".gitignore"
|
|
74
75
|
- ".rspec"
|
|
75
76
|
- ".rubocop.yml"
|
|
76
|
-
- ".standard.yml"
|
|
77
77
|
- Appraisals
|
|
78
78
|
- Gemfile
|
|
79
79
|
- LICENSE.txt
|
|
@@ -97,9 +97,6 @@ files:
|
|
|
97
97
|
- benchmarks/type_casts/bm_active_record.rb
|
|
98
98
|
- benchmarks/type_casts/bm_panko.rb
|
|
99
99
|
- benchmarks/type_casts/support.rb
|
|
100
|
-
- docs/.DS_Store
|
|
101
|
-
- docs/README.md
|
|
102
|
-
- docs/core/Footer.js
|
|
103
100
|
- docs/docs/associations.md
|
|
104
101
|
- docs/docs/attributes.md
|
|
105
102
|
- docs/docs/design-choices.md
|
|
@@ -107,12 +104,13 @@ files:
|
|
|
107
104
|
- docs/docs/introduction.md
|
|
108
105
|
- docs/docs/performance.md
|
|
109
106
|
- docs/docs/response-bag.md
|
|
110
|
-
- docs/
|
|
107
|
+
- docs/docusaurus.config.js
|
|
111
108
|
- docs/package-lock.json
|
|
112
109
|
- docs/package.json
|
|
113
110
|
- docs/sidebars.json
|
|
114
|
-
- docs/
|
|
111
|
+
- docs/src/css/customTheme.css
|
|
115
112
|
- docs/static/.DS_Store
|
|
113
|
+
- docs/static/CNAME
|
|
116
114
|
- docs/static/css/custom.css
|
|
117
115
|
- docs/static/img/favicon.ico
|
|
118
116
|
- docs/static/img/oss_logo.png
|
|
@@ -150,12 +148,14 @@ files:
|
|
|
150
148
|
- ext/panko_serializer/serialization_descriptor/attribute.h
|
|
151
149
|
- ext/panko_serializer/serialization_descriptor/serialization_descriptor.c
|
|
152
150
|
- ext/panko_serializer/serialization_descriptor/serialization_descriptor.h
|
|
153
|
-
- gemfiles/6.1.0.gemfile
|
|
154
|
-
- gemfiles/6.1.0.gemfile.lock
|
|
155
151
|
- gemfiles/7.0.0.gemfile
|
|
156
152
|
- gemfiles/7.0.0.gemfile.lock
|
|
157
153
|
- gemfiles/7.1.0.gemfile
|
|
158
154
|
- gemfiles/7.1.0.gemfile.lock
|
|
155
|
+
- gemfiles/7.2.0.gemfile
|
|
156
|
+
- gemfiles/7.2.0.gemfile.lock
|
|
157
|
+
- gemfiles/8.0.0.gemfile
|
|
158
|
+
- gemfiles/8.0.0.gemfile.lock
|
|
159
159
|
- lib/panko/array_serializer.rb
|
|
160
160
|
- lib/panko/association.rb
|
|
161
161
|
- lib/panko/attribute.rb
|
|
@@ -183,14 +183,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
|
|
|
183
183
|
requirements:
|
|
184
184
|
- - ">="
|
|
185
185
|
- !ruby/object:Gem::Version
|
|
186
|
-
version:
|
|
186
|
+
version: 3.1.0
|
|
187
187
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
|
188
188
|
requirements:
|
|
189
189
|
- - ">="
|
|
190
190
|
- !ruby/object:Gem::Version
|
|
191
191
|
version: '0'
|
|
192
192
|
requirements: []
|
|
193
|
-
rubygems_version: 3.5.
|
|
193
|
+
rubygems_version: 3.5.23
|
|
194
194
|
signing_key:
|
|
195
195
|
specification_version: 4
|
|
196
196
|
summary: High Performance JSON Serialization for ActiveRecord & Ruby Objects
|
data/.standard.yml
DELETED
data/docs/.DS_Store
DELETED
|
Binary file
|
data/docs/README.md
DELETED
|
@@ -1,198 +0,0 @@
|
|
|
1
|
-
This website was created with [Docusaurus](https://docusaurus.io/).
|
|
2
|
-
|
|
3
|
-
# What's In This Document
|
|
4
|
-
|
|
5
|
-
- [Get Started in 5 Minutes](#get-started-in-5-minutes)
|
|
6
|
-
- [Directory Structure](#directory-structure)
|
|
7
|
-
- [Editing Content](#editing-content)
|
|
8
|
-
- [Adding Content](#adding-content)
|
|
9
|
-
- [Full Documentation](#full-documentation)
|
|
10
|
-
|
|
11
|
-
# Get Started in 5 Minutes
|
|
12
|
-
|
|
13
|
-
1. Make sure all the dependencies for the website are installed:
|
|
14
|
-
|
|
15
|
-
```sh
|
|
16
|
-
# Install dependencies
|
|
17
|
-
$ yarn
|
|
18
|
-
```
|
|
19
|
-
|
|
20
|
-
2. Run your dev server:
|
|
21
|
-
|
|
22
|
-
```sh
|
|
23
|
-
# Start the site
|
|
24
|
-
$ yarn start
|
|
25
|
-
```
|
|
26
|
-
|
|
27
|
-
## Directory Structure
|
|
28
|
-
|
|
29
|
-
Your project file structure should look something like this
|
|
30
|
-
|
|
31
|
-
```
|
|
32
|
-
my-docusaurus/
|
|
33
|
-
docs/
|
|
34
|
-
doc-1.md
|
|
35
|
-
doc-2.md
|
|
36
|
-
doc-3.md
|
|
37
|
-
website/
|
|
38
|
-
blog/
|
|
39
|
-
2016-3-11-oldest-post.md
|
|
40
|
-
2017-10-24-newest-post.md
|
|
41
|
-
core/
|
|
42
|
-
node_modules/
|
|
43
|
-
pages/
|
|
44
|
-
static/
|
|
45
|
-
css/
|
|
46
|
-
img/
|
|
47
|
-
package.json
|
|
48
|
-
sidebars.json
|
|
49
|
-
siteConfig.js
|
|
50
|
-
```
|
|
51
|
-
|
|
52
|
-
# Editing Content
|
|
53
|
-
|
|
54
|
-
## Editing an existing docs page
|
|
55
|
-
|
|
56
|
-
Edit docs by navigating to `docs/` and editing the corresponding document:
|
|
57
|
-
|
|
58
|
-
`docs/doc-to-be-edited.md`
|
|
59
|
-
|
|
60
|
-
```markdown
|
|
61
|
-
---
|
|
62
|
-
id: page-needs-edit
|
|
63
|
-
title: This Doc Needs To Be Edited
|
|
64
|
-
---
|
|
65
|
-
|
|
66
|
-
Edit me...
|
|
67
|
-
```
|
|
68
|
-
|
|
69
|
-
For more information about docs, click [here](https://docusaurus.io/docs/en/navigation)
|
|
70
|
-
|
|
71
|
-
## Editing an existing blog post
|
|
72
|
-
|
|
73
|
-
Edit blog posts by navigating to `website/blog` and editing the corresponding post:
|
|
74
|
-
|
|
75
|
-
`website/blog/post-to-be-edited.md`
|
|
76
|
-
|
|
77
|
-
```markdown
|
|
78
|
-
---
|
|
79
|
-
id: post-needs-edit
|
|
80
|
-
title: This Blog Post Needs To Be Edited
|
|
81
|
-
---
|
|
82
|
-
|
|
83
|
-
Edit me...
|
|
84
|
-
```
|
|
85
|
-
|
|
86
|
-
For more information about blog posts, click [here](https://docusaurus.io/docs/en/adding-blog)
|
|
87
|
-
|
|
88
|
-
# Adding Content
|
|
89
|
-
|
|
90
|
-
## Adding a new docs page to an existing sidebar
|
|
91
|
-
|
|
92
|
-
1. Create the doc as a new markdown file in `/docs`, example `docs/newly-created-doc.md`:
|
|
93
|
-
|
|
94
|
-
```md
|
|
95
|
-
---
|
|
96
|
-
id: newly-created-doc
|
|
97
|
-
title: This Doc Needs To Be Edited
|
|
98
|
-
---
|
|
99
|
-
|
|
100
|
-
My new content here..
|
|
101
|
-
```
|
|
102
|
-
|
|
103
|
-
1. Refer to that doc's ID in an existing sidebar in `website/sidebars.json`:
|
|
104
|
-
|
|
105
|
-
```javascript
|
|
106
|
-
// Add newly-created-doc to the Getting Started category of docs
|
|
107
|
-
{
|
|
108
|
-
"docs": {
|
|
109
|
-
"Getting Started": [
|
|
110
|
-
"quick-start",
|
|
111
|
-
"newly-created-doc" // new doc here
|
|
112
|
-
],
|
|
113
|
-
...
|
|
114
|
-
},
|
|
115
|
-
...
|
|
116
|
-
}
|
|
117
|
-
```
|
|
118
|
-
|
|
119
|
-
For more information about adding new docs, click [here](https://docusaurus.io/docs/en/navigation)
|
|
120
|
-
|
|
121
|
-
## Adding a new blog post
|
|
122
|
-
|
|
123
|
-
1. Make sure there is a header link to your blog in `website/siteConfig.js`:
|
|
124
|
-
|
|
125
|
-
`website/siteConfig.js`
|
|
126
|
-
|
|
127
|
-
```javascript
|
|
128
|
-
headerLinks: [
|
|
129
|
-
...
|
|
130
|
-
{ blog: true, label: 'Blog' },
|
|
131
|
-
...
|
|
132
|
-
]
|
|
133
|
-
```
|
|
134
|
-
|
|
135
|
-
2. Create the blog post with the format `YYYY-MM-DD-My-Blog-Post-Title.md` in `website/blog`:
|
|
136
|
-
|
|
137
|
-
`website/blog/2018-05-21-New-Blog-Post.md`
|
|
138
|
-
|
|
139
|
-
```markdown
|
|
140
|
-
---
|
|
141
|
-
author: Frank Li
|
|
142
|
-
authorURL: https://twitter.com/foobarbaz
|
|
143
|
-
authorFBID: 503283835
|
|
144
|
-
title: New Blog Post
|
|
145
|
-
---
|
|
146
|
-
|
|
147
|
-
Lorem Ipsum...
|
|
148
|
-
```
|
|
149
|
-
|
|
150
|
-
For more information about blog posts, click [here](https://docusaurus.io/docs/en/adding-blog)
|
|
151
|
-
|
|
152
|
-
## Adding items to your site's top navigation bar
|
|
153
|
-
|
|
154
|
-
1. Add links to docs, custom pages or external links by editing the headerLinks field of `website/siteConfig.js`:
|
|
155
|
-
|
|
156
|
-
`website/siteConfig.js`
|
|
157
|
-
|
|
158
|
-
```javascript
|
|
159
|
-
{
|
|
160
|
-
headerLinks: [
|
|
161
|
-
...
|
|
162
|
-
/* you can add docs */
|
|
163
|
-
{ doc: 'my-examples', label: 'Examples' },
|
|
164
|
-
/* you can add custom pages */
|
|
165
|
-
{ page: 'help', label: 'Help' },
|
|
166
|
-
/* you can add external links */
|
|
167
|
-
{ href: 'https://github.com/facebook/docusaurus', label: 'GitHub' },
|
|
168
|
-
...
|
|
169
|
-
],
|
|
170
|
-
...
|
|
171
|
-
}
|
|
172
|
-
```
|
|
173
|
-
|
|
174
|
-
For more information about the navigation bar, click [here](https://docusaurus.io/docs/en/navigation)
|
|
175
|
-
|
|
176
|
-
## Adding custom pages
|
|
177
|
-
|
|
178
|
-
1. Docusaurus uses React components to build pages. The components are saved as .js files in `website/pages/en`:
|
|
179
|
-
1. If you want your page to show up in your navigation header, you will need to update `website/siteConfig.js` to add to the `headerLinks` element:
|
|
180
|
-
|
|
181
|
-
`website/siteConfig.js`
|
|
182
|
-
|
|
183
|
-
```javascript
|
|
184
|
-
{
|
|
185
|
-
headerLinks: [
|
|
186
|
-
...
|
|
187
|
-
{ page: 'my-new-custom-page', label: 'My New Custom Page' },
|
|
188
|
-
...
|
|
189
|
-
],
|
|
190
|
-
...
|
|
191
|
-
}
|
|
192
|
-
```
|
|
193
|
-
|
|
194
|
-
For more information about custom pages, click [here](https://docusaurus.io/docs/en/custom-pages).
|
|
195
|
-
|
|
196
|
-
# Full Documentation
|
|
197
|
-
|
|
198
|
-
Full documentation can be found on the [website](https://docusaurus.io/).
|
data/docs/core/Footer.js
DELETED
|
@@ -1,80 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Copyright (c) 2017-present, Facebook, Inc.
|
|
3
|
-
*
|
|
4
|
-
* This source code is licensed under the MIT license found in the
|
|
5
|
-
* LICENSE file in the root directory of this source tree.
|
|
6
|
-
*/
|
|
7
|
-
|
|
8
|
-
const React = require('react');
|
|
9
|
-
|
|
10
|
-
class Footer extends React.Component {
|
|
11
|
-
docUrl(doc, language) {
|
|
12
|
-
const baseUrl = this.props.config.baseUrl;
|
|
13
|
-
const docsUrl = this.props.config.docsUrl;
|
|
14
|
-
const docsPart = `${docsUrl ? `${docsUrl}/` : ''}`;
|
|
15
|
-
return `${baseUrl}${docsPart}${doc}`;
|
|
16
|
-
}
|
|
17
|
-
|
|
18
|
-
pageUrl(doc, language) {
|
|
19
|
-
const baseUrl = this.props.config.baseUrl;
|
|
20
|
-
return baseUrl + (language ? `${language}/` : '') + doc;
|
|
21
|
-
}
|
|
22
|
-
|
|
23
|
-
render() {
|
|
24
|
-
return (
|
|
25
|
-
<footer className="nav-footer" id="footer">
|
|
26
|
-
<section className="sitemap">
|
|
27
|
-
<a href={this.props.config.baseUrl} className="nav-home">
|
|
28
|
-
{this.props.config.footerIcon && (
|
|
29
|
-
<img
|
|
30
|
-
src={this.props.config.baseUrl + this.props.config.footerIcon}
|
|
31
|
-
alt={this.props.config.title}
|
|
32
|
-
width="66"
|
|
33
|
-
height="58"
|
|
34
|
-
/>
|
|
35
|
-
)}
|
|
36
|
-
</a>
|
|
37
|
-
<div>
|
|
38
|
-
<h5>Docs</h5>
|
|
39
|
-
<a href={this.docUrl('getting-started.html', this.props.language)}>
|
|
40
|
-
Getting Started
|
|
41
|
-
</a>
|
|
42
|
-
<a href={this.docUrl('attributes.html', this.props.language)}>
|
|
43
|
-
Guides
|
|
44
|
-
</a>
|
|
45
|
-
<a href={this.docUrl('performance.html', this.props.language)}>
|
|
46
|
-
Performance
|
|
47
|
-
</a>
|
|
48
|
-
</div>
|
|
49
|
-
<div>
|
|
50
|
-
<h5>More</h5>
|
|
51
|
-
<a href="https://github.com/yosiat/panko_serializer">GitHub</a>
|
|
52
|
-
<a
|
|
53
|
-
className="github-button"
|
|
54
|
-
href={this.props.config.repoUrl}
|
|
55
|
-
data-icon="octicon-star"
|
|
56
|
-
data-count-href="/yosiat/panko_serializer/stargazers"
|
|
57
|
-
data-show-count="true"
|
|
58
|
-
data-count-aria-label="# stargazers on GitHub"
|
|
59
|
-
aria-label="Star this project on GitHub">
|
|
60
|
-
Star
|
|
61
|
-
</a>
|
|
62
|
-
{this.props.config.twitterUsername && (
|
|
63
|
-
<div className="social">
|
|
64
|
-
<a
|
|
65
|
-
href={`https://twitter.com/${this.props.config.twitterUsername}`}
|
|
66
|
-
className="twitter-follow-button">
|
|
67
|
-
Follow @{this.props.config.twitterUsername}
|
|
68
|
-
</a>
|
|
69
|
-
</div>
|
|
70
|
-
)}
|
|
71
|
-
</div>
|
|
72
|
-
</section>
|
|
73
|
-
|
|
74
|
-
<section className="copyright">{this.props.config.copyright}</section>
|
|
75
|
-
</footer>
|
|
76
|
-
);
|
|
77
|
-
}
|
|
78
|
-
}
|
|
79
|
-
|
|
80
|
-
module.exports = Footer;
|
data/docs/i18n/en.json
DELETED
|
@@ -1,50 +0,0 @@
|
|
|
1
|
-
{
|
|
2
|
-
"_comment": "This file is auto-generated by write-translations.js",
|
|
3
|
-
"localized-strings": {
|
|
4
|
-
"next": "Next",
|
|
5
|
-
"previous": "Previous",
|
|
6
|
-
"tagline": "High Performance JSON Serialization for ActiveRecord & Ruby Objects",
|
|
7
|
-
"docs": {
|
|
8
|
-
"associations": {
|
|
9
|
-
"title": "Associations",
|
|
10
|
-
"sidebar_label": "Associations"
|
|
11
|
-
},
|
|
12
|
-
"attributes": {
|
|
13
|
-
"title": "Attributes",
|
|
14
|
-
"sidebar_label": "Attributes"
|
|
15
|
-
},
|
|
16
|
-
"design-choices": {
|
|
17
|
-
"title": "Design Choices",
|
|
18
|
-
"sidebar_label": "Design Choices"
|
|
19
|
-
},
|
|
20
|
-
"getting-started": {
|
|
21
|
-
"title": "Getting Started",
|
|
22
|
-
"sidebar_label": "Getting Started"
|
|
23
|
-
},
|
|
24
|
-
"index": {
|
|
25
|
-
"title": "Introduction",
|
|
26
|
-
"sidebar_label": "Introduction"
|
|
27
|
-
},
|
|
28
|
-
"performance": {
|
|
29
|
-
"title": "Performance",
|
|
30
|
-
"sidebar_label": "Performance"
|
|
31
|
-
},
|
|
32
|
-
"response-bag": {
|
|
33
|
-
"title": "Response",
|
|
34
|
-
"sidebar_label": "Response"
|
|
35
|
-
}
|
|
36
|
-
},
|
|
37
|
-
"links": {
|
|
38
|
-
"Docs": "Docs"
|
|
39
|
-
},
|
|
40
|
-
"categories": {
|
|
41
|
-
"Panko": "Panko",
|
|
42
|
-
"Reference": "Reference"
|
|
43
|
-
}
|
|
44
|
-
},
|
|
45
|
-
"pages-strings": {
|
|
46
|
-
"Help Translate|recruit community translators for your project": "Help Translate",
|
|
47
|
-
"Edit this Doc|recruitment message asking to edit the doc source": "Edit",
|
|
48
|
-
"Translate this Doc|recruitment message asking to translate the docs": "Translate"
|
|
49
|
-
}
|
|
50
|
-
}
|