Skip to content

Commit 57e487a

Browse files
committed
feat: building JavaScript docs locally
- Import Jekyll material from graphic-library-docs repository. - Remove (most) mentions of languages other than Python and JavaScript. - Add Makefile to re-run commands.
1 parent ba538c3 commit 57e487a

File tree

1,584 files changed

+167420
-3
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,584 files changed

+167420
-3
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
node_modules
2+
_site
23

34
build/*
45
!build/plotcss.js

docs/.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
_data/plotschema.json

docs/Gemfile

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
source 'https://rubygems.org'
2+
gem 'github-pages'
3+
gem 'jekyll-redirect-from'
4+
gem 'jemoji'
5+
gem 'octopress'
6+
gem 'rake'
7+
gem 'jekyll-sitemap'
8+
gem 'percy-cli'
9+
gem 'webrick'
10+
11+
group :jekyll_plugins do
12+
gem 'octopress-debugger'
13+
end
14+
15+
group :jekyll_plugins do
16+
gem 'algoliasearch-jekyll', '~> 0.8.2'
17+
end

docs/Gemfile.lock

Lines changed: 338 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,338 @@
1+
GEM
2+
remote: https://rubygems.org/
3+
specs:
4+
activesupport (7.1.3.2)
5+
base64
6+
bigdecimal
7+
concurrent-ruby (~> 1.0, >= 1.0.2)
8+
connection_pool (>= 2.2.5)
9+
drb
10+
i18n (>= 1.6, < 2)
11+
minitest (>= 5.1)
12+
mutex_m
13+
tzinfo (~> 2.0)
14+
addressable (2.8.7)
15+
public_suffix (>= 2.0.2, < 7.0)
16+
algoliasearch (1.27.5)
17+
httpclient (~> 2.8, >= 2.8.3)
18+
json (>= 1.5.1)
19+
algoliasearch-jekyll (0.8.2)
20+
algoliasearch (~> 1.4)
21+
appraisal (~> 2.1.0)
22+
awesome_print (~> 1.6)
23+
json (>= 1.8.6)
24+
nokogiri (~> 1.7, >= 1.7.2)
25+
verbal_expressions (~> 0.1.5)
26+
appraisal (2.1.0)
27+
bundler
28+
rake
29+
thor (>= 0.14.0)
30+
awesome_print (1.9.2)
31+
base64 (0.2.0)
32+
bigdecimal (3.1.7)
33+
byebug (11.1.3)
34+
coderay (1.1.3)
35+
coffee-script (2.4.1)
36+
coffee-script-source
37+
execjs
38+
coffee-script-source (1.12.2)
39+
colorator (1.1.0)
40+
commander (4.6.0)
41+
highline (~> 2.0.0)
42+
commonmarker (0.23.10)
43+
concurrent-ruby (1.3.5)
44+
connection_pool (2.4.1)
45+
dnsruby (1.71.0)
46+
simpleidn (~> 0.2.1)
47+
drb (2.2.1)
48+
em-websocket (0.5.3)
49+
eventmachine (>= 0.12.9)
50+
http_parser.rb (~> 0)
51+
ethon (0.16.0)
52+
ffi (>= 1.15.0)
53+
eventmachine (1.2.7)
54+
excon (0.105.0)
55+
execjs (2.9.1)
56+
faraday (0.15.4)
57+
multipart-post (>= 1.2, < 3)
58+
ffi (1.17.2-arm64-darwin)
59+
forwardable-extended (2.6.0)
60+
gemoji (4.1.0)
61+
github-pages (231)
62+
github-pages-health-check (= 1.18.2)
63+
jekyll (= 3.9.5)
64+
jekyll-avatar (= 0.8.0)
65+
jekyll-coffeescript (= 1.2.2)
66+
jekyll-commonmark-ghpages (= 0.4.0)
67+
jekyll-default-layout (= 0.1.5)
68+
jekyll-feed (= 0.17.0)
69+
jekyll-gist (= 1.5.0)
70+
jekyll-github-metadata (= 2.16.1)
71+
jekyll-include-cache (= 0.2.1)
72+
jekyll-mentions (= 1.6.0)
73+
jekyll-optional-front-matter (= 0.3.2)
74+
jekyll-paginate (= 1.1.0)
75+
jekyll-readme-index (= 0.3.0)
76+
jekyll-redirect-from (= 0.16.0)
77+
jekyll-relative-links (= 0.6.1)
78+
jekyll-remote-theme (= 0.4.3)
79+
jekyll-sass-converter (= 1.5.2)
80+
jekyll-seo-tag (= 2.8.0)
81+
jekyll-sitemap (= 1.4.0)
82+
jekyll-swiss (= 1.0.0)
83+
jekyll-theme-architect (= 0.2.0)
84+
jekyll-theme-cayman (= 0.2.0)
85+
jekyll-theme-dinky (= 0.2.0)
86+
jekyll-theme-hacker (= 0.2.0)
87+
jekyll-theme-leap-day (= 0.2.0)
88+
jekyll-theme-merlot (= 0.2.0)
89+
jekyll-theme-midnight (= 0.2.0)
90+
jekyll-theme-minimal (= 0.2.0)
91+
jekyll-theme-modernist (= 0.2.0)
92+
jekyll-theme-primer (= 0.6.0)
93+
jekyll-theme-slate (= 0.2.0)
94+
jekyll-theme-tactile (= 0.2.0)
95+
jekyll-theme-time-machine (= 0.2.0)
96+
jekyll-titles-from-headings (= 0.5.3)
97+
jemoji (= 0.13.0)
98+
kramdown (= 2.4.0)
99+
kramdown-parser-gfm (= 1.1.0)
100+
liquid (= 4.0.4)
101+
mercenary (~> 0.3)
102+
minima (= 2.5.1)
103+
nokogiri (>= 1.13.6, < 2.0)
104+
rouge (= 3.30.0)
105+
terminal-table (~> 1.4)
106+
github-pages-health-check (1.18.2)
107+
addressable (~> 2.3)
108+
dnsruby (~> 1.60)
109+
octokit (>= 4, < 8)
110+
public_suffix (>= 3.0, < 6.0)
111+
typhoeus (~> 1.3)
112+
highline (2.0.3)
113+
html-pipeline (2.14.3)
114+
activesupport (>= 2)
115+
nokogiri (>= 1.4)
116+
http_parser.rb (0.8.0)
117+
httpclient (2.8.3)
118+
i18n (1.14.7)
119+
concurrent-ruby (~> 1.0)
120+
jekyll (3.9.5)
121+
addressable (~> 2.4)
122+
colorator (~> 1.0)
123+
em-websocket (~> 0.5)
124+
i18n (>= 0.7, < 2)
125+
jekyll-sass-converter (~> 1.0)
126+
jekyll-watch (~> 2.0)
127+
kramdown (>= 1.17, < 3)
128+
liquid (~> 4.0)
129+
mercenary (~> 0.3.3)
130+
pathutil (~> 0.9)
131+
rouge (>= 1.7, < 4)
132+
safe_yaml (~> 1.0)
133+
jekyll-avatar (0.8.0)
134+
jekyll (>= 3.0, < 5.0)
135+
jekyll-coffeescript (1.2.2)
136+
coffee-script (~> 2.2)
137+
coffee-script-source (~> 1.12)
138+
jekyll-commonmark (1.4.0)
139+
commonmarker (~> 0.22)
140+
jekyll-commonmark-ghpages (0.4.0)
141+
commonmarker (~> 0.23.7)
142+
jekyll (~> 3.9.0)
143+
jekyll-commonmark (~> 1.4.0)
144+
rouge (>= 2.0, < 5.0)
145+
jekyll-default-layout (0.1.5)
146+
jekyll (>= 3.0, < 5.0)
147+
jekyll-feed (0.17.0)
148+
jekyll (>= 3.7, < 5.0)
149+
jekyll-gist (1.5.0)
150+
octokit (~> 4.2)
151+
jekyll-github-metadata (2.16.1)
152+
jekyll (>= 3.4, < 5.0)
153+
octokit (>= 4, < 7, != 4.4.0)
154+
jekyll-include-cache (0.2.1)
155+
jekyll (>= 3.7, < 5.0)
156+
jekyll-mentions (1.6.0)
157+
html-pipeline (~> 2.3)
158+
jekyll (>= 3.7, < 5.0)
159+
jekyll-optional-front-matter (0.3.2)
160+
jekyll (>= 3.0, < 5.0)
161+
jekyll-paginate (1.1.0)
162+
jekyll-readme-index (0.3.0)
163+
jekyll (>= 3.0, < 5.0)
164+
jekyll-redirect-from (0.16.0)
165+
jekyll (>= 3.3, < 5.0)
166+
jekyll-relative-links (0.6.1)
167+
jekyll (>= 3.3, < 5.0)
168+
jekyll-remote-theme (0.4.3)
169+
addressable (~> 2.0)
170+
jekyll (>= 3.5, < 5.0)
171+
jekyll-sass-converter (>= 1.0, <= 3.0.0, != 2.0.0)
172+
rubyzip (>= 1.3.0, < 3.0)
173+
jekyll-sass-converter (1.5.2)
174+
sass (~> 3.4)
175+
jekyll-seo-tag (2.8.0)
176+
jekyll (>= 3.8, < 5.0)
177+
jekyll-sitemap (1.4.0)
178+
jekyll (>= 3.7, < 5.0)
179+
jekyll-swiss (1.0.0)
180+
jekyll-theme-architect (0.2.0)
181+
jekyll (> 3.5, < 5.0)
182+
jekyll-seo-tag (~> 2.0)
183+
jekyll-theme-cayman (0.2.0)
184+
jekyll (> 3.5, < 5.0)
185+
jekyll-seo-tag (~> 2.0)
186+
jekyll-theme-dinky (0.2.0)
187+
jekyll (> 3.5, < 5.0)
188+
jekyll-seo-tag (~> 2.0)
189+
jekyll-theme-hacker (0.2.0)
190+
jekyll (> 3.5, < 5.0)
191+
jekyll-seo-tag (~> 2.0)
192+
jekyll-theme-leap-day (0.2.0)
193+
jekyll (> 3.5, < 5.0)
194+
jekyll-seo-tag (~> 2.0)
195+
jekyll-theme-merlot (0.2.0)
196+
jekyll (> 3.5, < 5.0)
197+
jekyll-seo-tag (~> 2.0)
198+
jekyll-theme-midnight (0.2.0)
199+
jekyll (> 3.5, < 5.0)
200+
jekyll-seo-tag (~> 2.0)
201+
jekyll-theme-minimal (0.2.0)
202+
jekyll (> 3.5, < 5.0)
203+
jekyll-seo-tag (~> 2.0)
204+
jekyll-theme-modernist (0.2.0)
205+
jekyll (> 3.5, < 5.0)
206+
jekyll-seo-tag (~> 2.0)
207+
jekyll-theme-primer (0.6.0)
208+
jekyll (> 3.5, < 5.0)
209+
jekyll-github-metadata (~> 2.9)
210+
jekyll-seo-tag (~> 2.0)
211+
jekyll-theme-slate (0.2.0)
212+
jekyll (> 3.5, < 5.0)
213+
jekyll-seo-tag (~> 2.0)
214+
jekyll-theme-tactile (0.2.0)
215+
jekyll (> 3.5, < 5.0)
216+
jekyll-seo-tag (~> 2.0)
217+
jekyll-theme-time-machine (0.2.0)
218+
jekyll (> 3.5, < 5.0)
219+
jekyll-seo-tag (~> 2.0)
220+
jekyll-titles-from-headings (0.5.3)
221+
jekyll (>= 3.3, < 5.0)
222+
jekyll-watch (2.2.1)
223+
listen (~> 3.0)
224+
jemoji (0.13.0)
225+
gemoji (>= 3, < 5)
226+
html-pipeline (~> 2.2)
227+
jekyll (>= 3.0, < 5.0)
228+
json (2.7.1)
229+
kramdown (2.4.0)
230+
rexml
231+
kramdown-parser-gfm (1.1.0)
232+
kramdown (~> 2.0)
233+
liquid (4.0.4)
234+
listen (3.9.0)
235+
rb-fsevent (~> 0.10, >= 0.10.3)
236+
rb-inotify (~> 0.9, >= 0.9.10)
237+
mercenary (0.3.6)
238+
method_source (1.0.0)
239+
minima (2.5.1)
240+
jekyll (>= 3.5, < 5.0)
241+
jekyll-feed (~> 0.9)
242+
jekyll-seo-tag (~> 2.1)
243+
minitest (5.22.3)
244+
multipart-post (2.4.0)
245+
mutex_m (0.2.0)
246+
nokogiri (1.16.7-arm64-darwin)
247+
racc (~> 1.4)
248+
octokit (4.22.0)
249+
faraday (>= 0.9)
250+
sawyer (~> 0.8.0, >= 0.5.3)
251+
octopress (3.0.11)
252+
jekyll (>= 2.0)
253+
mercenary (~> 0.3.2)
254+
octopress-deploy
255+
octopress-escape-code (~> 2.0)
256+
octopress-hooks (~> 2.0)
257+
redcarpet (~> 3.0)
258+
titlecase
259+
octopress-debugger (1.0.2)
260+
jekyll
261+
pry-byebug
262+
octopress-deploy (1.3.0)
263+
colorator
264+
octopress-escape-code (2.1.1)
265+
jekyll (~> 3.0)
266+
octopress-hooks (2.6.2)
267+
jekyll (>= 2.0)
268+
pathutil (0.16.2)
269+
forwardable-extended (~> 2.6)
270+
percy-cli (1.4.0)
271+
addressable (~> 2)
272+
commander (~> 4.3)
273+
percy-client (~> 2.0)
274+
thread (~> 0.2)
275+
percy-client (2.1.1)
276+
addressable
277+
excon (= 0.105.0)
278+
faraday (= 0.15.4)
279+
pry (0.14.2)
280+
coderay (~> 1.1)
281+
method_source (~> 1.0)
282+
pry-byebug (3.10.1)
283+
byebug (~> 11.0)
284+
pry (>= 0.13, < 0.15)
285+
public_suffix (5.0.4)
286+
racc (1.7.3)
287+
rake (13.1.0)
288+
rb-fsevent (0.11.2)
289+
rb-inotify (0.11.1)
290+
ffi (~> 1.0)
291+
redcarpet (3.6.0)
292+
rexml (3.4.1)
293+
rouge (3.30.0)
294+
rubyzip (2.3.2)
295+
safe_yaml (1.0.5)
296+
sass (3.7.4)
297+
sass-listen (~> 4.0.0)
298+
sass-listen (4.0.0)
299+
rb-fsevent (~> 0.9, >= 0.9.4)
300+
rb-inotify (~> 0.9, >= 0.9.7)
301+
sawyer (0.8.2)
302+
addressable (>= 2.3.5)
303+
faraday (> 0.8, < 2.0)
304+
simpleidn (0.2.1)
305+
unf (~> 0.1.4)
306+
terminal-table (1.8.0)
307+
unicode-display_width (~> 1.1, >= 1.1.1)
308+
thor (1.3.1)
309+
thread (0.2.2)
310+
titlecase (0.1.1)
311+
typhoeus (1.4.1)
312+
ethon (>= 0.9.0)
313+
tzinfo (2.0.6)
314+
concurrent-ruby (~> 1.0)
315+
unf (0.1.4)
316+
unf_ext
317+
unf_ext (0.0.9.1)
318+
unicode-display_width (1.8.0)
319+
verbal_expressions (0.1.5)
320+
webrick (1.9.1)
321+
322+
PLATFORMS
323+
arm64-darwin-23
324+
325+
DEPENDENCIES
326+
algoliasearch-jekyll (~> 0.8.2)
327+
github-pages
328+
jekyll-redirect-from
329+
jekyll-sitemap
330+
jemoji
331+
octopress
332+
octopress-debugger
333+
percy-cli
334+
rake
335+
webrick
336+
337+
BUNDLED WITH
338+
2.4.22

docs/Makefile

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Manage plotly.js documentation.
2+
3+
JEKYLL=bundle exec jekyll
4+
SCHEMA_SRC=../test/plot-schema.json
5+
SCHEMA_DST=_data/plotschema.json
6+
7+
## commands: show available commands
8+
commands:
9+
@grep -h -E '^##' ${MAKEFILE_LIST} | sed -e 's/## //g' | column -t -s ':'
10+
11+
## build: rebuild documentation
12+
build:
13+
@mkdir -p _data
14+
cp ${SCHEMA_SRC} ${SCHEMA_DST}
15+
${JEKYLL} build
16+
17+
## serve: display documentation
18+
serve:
19+
@mkdir -p _data
20+
cp ${SCHEMA_SRC} ${SCHEMA_DST}
21+
${JEKYLL} serve
22+
23+
## --: --
24+
25+
## clean: clean up repository
26+
clean:
27+
@find . -name '*~' -delete
28+
@find . -name '.DS_Store' -delete
29+
@rm -rf _site
30+
@rm -f ${SCHEMA_DST}

0 commit comments

Comments
 (0)