Skip to content

Commit 70e4d92

Browse files
committed
fixed typo on twitter app creation
1 parent 94a242b commit 70e4d92

169 files changed

Lines changed: 13907 additions & 2606 deletions

File tree

Some content is hidden

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

docs/asciidoctor-reveal.js-master/.gitignore

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,19 +3,29 @@
33

44
# test stuff
55
/examples/*.html
6+
!/examples/docinfo*.html
7+
!/examples/*docinfo-revealjs.html
68
/examples/reveal.js/
79
/examples/node_modules
810

911
# node stuff
1012
node_modules/
1113
npm-debug.log
1214
build/
13-
/dist/main.js
15+
/dist/
1416
/asciidoctor-reveal.js-*.tgz
1517

1618
# ruby stuff
1719
/.bundle/
1820
/Gemfile.lock
1921

20-
# the compiled slim template
22+
# the compiled slim template, committed only on releases to avoid noise
2123
/lib/asciidoctor-revealjs/converter.rb
24+
25+
# ignored tests
26+
# - coderay is unsupported on JRuby
27+
test/doctest/source-coderay.html
28+
# - pygments is unsupported on JRuby
29+
test/doctest/source-pygments.html
30+
# - contains invalid content
31+
test/doctest/with-docinfo-shared.html
Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,14 @@
1-
sudo: false
21
git:
32
# use depth 2 just in case two refs get pushed at once (like a tag)
43
depth: 2
54
language: ruby
65
node_js: lts/*
76
rvm:
7+
- 2.6
88
- 2.5
99
- 2.4
1010
- 2.3
11-
- 2.2
12-
- 2.1
13-
- jruby-9k
11+
- jruby-9.2.9.0
1412
gemfile:
1513
- Gemfile
1614
- Gemfile.upstream
@@ -20,13 +18,11 @@ env:
2018
- NOKOGIRI_USE_SYSTEM_LIBRARIES=true
2119
script:
2220
- bundle exec rake build
23-
- bundle exec rake doctest
21+
- bundle exec rake test
2422
- bundle exec rake examples:convert
2523
- npm install
26-
- bundle exec rake build:converter:opal
27-
- npm run build
24+
- bundle exec rake build:js
2825
- npm run examples
2926
- npm test
30-
3127
notifications:
3228
email: false

docs/asciidoctor-reveal.js-master/CHANGELOG.adoc

Lines changed: 330 additions & 4 deletions
Large diffs are not rendered by default.

docs/asciidoctor-reveal.js-master/Gemfile

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,5 @@ source 'https://rubygems.org'
22

33
# Specify your gem's dependencies in asciidoctor-revealjs.gemspec
44
gemspec
5+
# Asciidoctor.js 2.0.0 requires an unreleased Opal 0.11.99.dev (d136ea8)
6+
gem 'opal', :git => 'https://github.com/opal/opal.git', :ref => 'd136ea8'

docs/asciidoctor-reveal.js-master/Gemfile.upstream

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,5 @@
33
source 'https://rubygems.org'
44
gemspec
55
gem 'asciidoctor', :git => 'https://github.com/asciidoctor/asciidoctor', :branch => 'master'
6+
# Asciidoctor.js 2.0.0 requires an unreleased Opal 0.11.99.dev (d136ea8)
7+
gem 'opal', :git => 'https://github.com/opal/opal.git', :ref => 'd136ea8'

docs/asciidoctor-reveal.js-master/HACKING.adoc

Lines changed: 139 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,21 @@
44

55
Short instructions that aim to help potential contributors.
66

7+
== Getting Started
8+
9+
* Setup the Asciidoctor-revealjs plugin in <<ruby-localversion,development mode>>
10+
* Modify the http://slim-lang.com/[slim templates] in `templates/`
11+
* Templates need to be compiled before being used, do so with:
12+
13+
bundle exec rake build
14+
15+
* Then using the following command will render slides with your template changes baked in:
16+
17+
bundle exec asciidoctor-revealjs <source.adoc>
18+
19+
The next section will provide further help on how to use `print` statements or a debugger to assist development.
20+
21+
722
== Inspect the template system
823

924
To understand what you have access to in templates you can inject some ruby.
@@ -15,9 +30,8 @@ Two complementary approaches can be used to explore the context offered by ascii
1530

1631
[NOTE]
1732
--
18-
Starting with v1.1.0 the slim templates are compiled to Ruby in order to
19-
use the same templates from Asciidoctor.js (Javascript / Node.js ecosystem).
20-
Don't forget to recompile the templates if you make changes to them.
33+
Debugging is only supported via the Ruby ecosystem.
34+
You need to recompile the templates when you make changes to them.
2135
This can be done by running:
2236

2337
bundle exec rake build
@@ -65,6 +79,10 @@ In order to be dropped into the debugger at a specific point in a template simpl
6579
- binding.pry
6680
----
6781

82+
Recompile the templates with:
83+
84+
bundle exec rake build
85+
6886
Then run `asciidoctor-revealjs` from the command-line to generate your document and you'll be dropped in the debugger:
6987

7088
----
@@ -96,13 +114,11 @@ You can also query asciidoctor's documentation:
96114
If you install the `pry-byebug` gem you get additional debugging capabilities.
97115
See the gem's documentation for details.
98116

99-
Since 1.1.0, templates are compiled. It is easier to inject the debug
100-
triggering statements and use the templates directly instead of debugging
101-
compiled templates. You can call the slim templates directly with:
117+
Since 1.1.0, templates are compiled.
118+
It is easier to inject the debug triggering statements and use the templates directly instead of debugging compiled templates.
119+
You can call the slim templates directly with:
102120

103-
// TODO it's still not clear whether `-r slim-htag` is required right now (#153)
104-
105-
bundle exec asciidoctor --trace -T templates/ examples/customcss.adoc
121+
bundle exec asciidoctor-revealjs --trace -T templates/ examples/customcss.adoc
106122

107123
=== References
108124

@@ -124,22 +140,22 @@ done with `bundler`:
124140
bundle --path=.bundle/gems --binstubs=.bundle/.bin
125141
bundle exec rake build
126142

127-
Go to `test/output/slim/` folder and install `reveal.js`:
143+
Go to `test/doctest` folder and install `reveal.js`:
128144

129-
cd test/output/slim/
145+
cd test/doctest/
130146
git clone https://github.com/hakimel/reveal.js.git
131147

132148
=== Render tests into .html
133149

134150
From the project's root directory:
135151

136-
bundle exec rake generate FORCE=yes
152+
bundle exec rake doctest::generate FORCE=yes
137153

138154
=== Open rendered files
139155

140156
NOTE: Right now, https://github.com/asciidoctor/asciidoctor-doctest/issues/12[doctest issue #12] means that the generated examples will not be pretty.
141157

142-
You can open the generated `.html` in `test/output/slim/` in a Web browser.
158+
You can open the generated `.html` in `test/doctest/` in a Web browser.
143159

144160

145161
== Asciidoctor API's gotchas
@@ -192,12 +208,14 @@ Well, for most people.
192208

193209
=== Work-in-progress pull-requests
194210

195-
If you prepend "WIP" in front of your pull request we will understand that it is not complete and we will not merge it before you remove the WIP string.
211+
Letting know to the maintainers that you are working on a feature or a fix is useful.
212+
Early communication often times save time consuming mistakes or avoids duplicated effort.
213+
We encourage contributors to communicate with us early.
196214

197-
This is useful to let people know that you are working on stuff.
198-
Branches are not that visible otherwise but pull requests are.
215+
Branches on forks of this project are not very visible to maintainers as much as pull requests (PR).
216+
For this reason we used to recommend sending a PR even if it's not ready and prepend "WIP" in front of its name to let everyone see that you are working on a specific topic.
217+
Now, instead of prepending "WIP", we recommend using GitHub "draft pull request" feature instead.
199218

200-
You might even be able to get some feedback early which could save you some time.
201219

202220
=== 'needs review' label
203221

@@ -211,8 +229,7 @@ Makes triaging easier.
211229

212230
In order to test the Node package, you first need to build the converter into Javascript and create a tarball of the project.
213231

214-
$ bundle exec rake build:converter:opal
215-
$ npm run build
232+
$ bundle exec rake build:js
216233
$ npm pack
217234

218235
That last command will produce a file named `asciidoctor-reveal.js-<version>.tgz` in the working directory.
@@ -230,16 +247,47 @@ NOTE: The relative portion of the last command is where you are installing the l
230247

231248
Then proceed as documented in the `README.adoc`.
232249

233-
=== Upgrade Asciidoctor.js version
250+
[[node-binary-compatibility]]
251+
=== Binary package compatibility with Asciidoctor.js
252+
253+
Asciidoctor.js is source-to-source compiled into JavaScript from Ruby using Opal.
254+
The JavaScript generated requires a specific version of the Opal-runtime for it to work with Node.js.
255+
This project is source-to-source compiled into JavaScript from Ruby using Opal too.
256+
In order for Asciidoctor.js to be able to call code from this converter, the versions of Opal (both runtime and compiler) must be compatible.
257+
Right now we track the exact git revision of Opal used by Asciidoctor.js and make sure that we match.
258+
Here is how:
259+
260+
Versions known to work together can be found by looking at the Asciidoctor.js release notes, just replace <tag> with the `asciidoctor.js` release you are interested in: https://github.com/asciidoctor/asciidoctor.js/releases/tag/<tag>.
261+
Then that Opal version and git revision (if required) must be specified in `asciidoctor-revealjs.gemspec`.
262+
263+
Starting with 3.0.0 we aim to retain binary compatibility between Asciidoctor.js and Asciidoctor-reveal.js.
264+
This should allow other Asciidoctor extensions to be called along with this converter.
265+
Asciidoctor.js is no longer a direct dependency but should be seen as a tool that powers this converter.
266+
We need to allow users to have flexibility in the version they choose to run.
267+
Asciidoctor.js maintainer told us that he is going to consider binary package incompatibility a major break and so we adjusted our README to tell users to install with a specific version range.
268+
269+
We will track and maintain the README on the major version supported and recommended:
270+
271+
* In the link:README.adoc#node-install[version range to install by default] for a given release (and on master)
272+
* In the link:README.adoc#asciidoctorjs-compatibility-matrix[compatibility matrix]
273+
274+
See https://github.com/asciidoctor/asciidoctor-reveal.js/issues/187#issuecomment-570771473[this issue] for background details on that topic.
275+
276+
Asciidoctor.js versioning policy is https://asciidoctor-docs.netlify.com/asciidoctor.js/project/version-and-lifecycle-policies/[available here].
277+
278+
=== Debugging
279+
280+
To debug the JavaScript application, just add `--node-arg=--inspect-brk` to the npx command to run the application.
281+
For example:
282+
283+
npx --node-arg=--inspect-brk asciidoctor-revealjs -v presentation.adoc
284+
285+
Then open the Chrome Dev Tools and click on the Node logo in the top left corner.
234286

235-
WARNING: It is important to track `Asciidoctor.js` and `bestikk-opal-compiler` versions together.
236-
The `opal-compiler` used to compile our node package must match `asciidoctor.js` `opal-runtime`.
237-
The former is explicitly installed by users on install and the later is specified in our `package.json`.
238-
When you update one remember to update the other.
239-
Versions known to work together can be found here, just replace <tag> with the `asciidoctor.js` release you are interested in: https://github.com/asciidoctor/asciidoctor.js/blob/<tag>/package.json
240287

241288
== RubyGem package
242289

290+
[[ruby-localversion]]
243291
=== Test a local asciidoctor-revealjs version
244292

245293
Compile the converter:
@@ -258,44 +306,82 @@ Then run:
258306

259307
== Release process
260308

309+
310+
. Make sure that the highlight plugin code embed in _lib/asciidoctor-revealjs/highlightjs.rb_ is up-to-date with the version of reveal.js
311+
. Do we need to do anything regarding our Opal dependency and Asciidoctor.js?
312+
See <<node-binary-compatibility,our section on the topic>>.
313+
. Update dependencies and test the package in both languages
314+
+
315+
bundle update
316+
bundle exec rake build
317+
bundle exec rake test
318+
bundle exec rake examples:convert
319+
npm install
320+
npm update
321+
bundle exec rake build:js
322+
npm test
323+
npm run examples
324+
325+
. Commit the updated dependencies
261326
. Update the version in `lib/asciidoctor-revealjs/version.rb` and `package.json`
262327
. Update the changelog
263328
** Generate author list with:
264329
+
265330
git log <prev-version-tag>.. --format="%aN" --reverse | perl -e 'my %dedupe; while (<STDIN>) { print unless $dedupe{$_}++}' | sort
266331

267332
. Prepare release commit
333+
** Add the "Slim compiled to Ruby" converter to the git tree (otherwise ignored to avoid noise to the repo)
334+
+
335+
bundle exec rake build
336+
git add -f lib/asciidoctor-revealjs/converter.rb
337+
268338
** commit msg: Prepare %version% release
269339
** release commit (--allow-empty) msg: Release %version%
270340
. Tag the release commit
271341
** Annotated Tag msg: Version %version%
272342
. Push your changes (including the tag)
273343
. Make a release on github (from changelog and copy from previous releases)
344+
** Useful vim regex for AsciiDoc to Markdown:
345+
+
346+
:%s/{uri-issue}\(\d\+\)\[#\d\+]/#\1/gc
347+
:%s/{project-name}/asciidoctor-reveal.js/gc
348+
:%s/\(.*\)::/### \1/gc
349+
:%s/{uri-repo}/https:\/\/github.com\/asciidoctor\/asciidoctor-reveal.js/gc
350+
351+
** Save as draft
352+
274353
. Pushing the gem on rubygems.org:
275354
+
276355
$ bundle exec rake build
277356
$ gem build asciidoctor-revealjs.gemspec
278357
$ gem push asciidoctor-revealjs-X.Y.Z.gem
279358

280359
. Check that the new version is available on https://rubygems.org/gems/asciidoctor-revealjs[rubygems.org]
281-
. Generate a compatible version of the Ruby converter (using opal mode)
282-
+
283-
$ bundle exec rake build:converter:opal
284-
285-
. Build the node package (make sure you have `devDependencies` installed with: `npm install`):
360+
. Generate the javascript version of the Ruby converter
286361
+
287-
$ npm run build
362+
$ bundle exec rake build:js
288363

289364
. Publish the node package on npm:
290365
+
291366
$ npm login # only required if not already authenticated
292367
$ npm publish
293368

294-
. Check that the new version is available on https://www.npmjs.com/package/asciidoctor-reveal.js[npmjs.com]
295-
. Update version in `lib/asciidoctor-revealjs/version.rb` and `package.json` (+1 bugfix and append '-dev') and commit
369+
. Check that the new version is available on https://www.npmjs.com/package/@asciidoctor/reveal.js[npmjs.com]
370+
. Make binaries release
371+
** Run `npm run package`. Binaries built will be in `dist/`. Upload them to the GitHub release page.
372+
. Publish previously saved GitHub release draft
373+
. Update version in `lib/asciidoctor-revealjs/version.rb` and `package.json` (+1 bugfix and append '-dev')
374+
** Remove the "Slim compiled to Ruby" converter to the git tree (to avoid noise to the repo and `git status` noise)
375+
+
376+
git rm --cached lib/asciidoctor-revealjs/converter.rb
377+
296378
** commit msg: Begin development on next release
297379
. Submit a PR upstream to sync the documentation on asciidoctor.org
298380
** Modify this page: https://github.com/asciidoctor/asciidoctor.org/edit/master/docs/asciidoctor-revealjs.adoc
381+
. Submit a PR downstream to update Asciidoctor reveal.js version inside docker-asciidoctor
382+
** Modify the `Dockerfile`, `Makefile` and `README.adoc` of: https://github.com/asciidoctor/docker-asciidoctor
383+
. Submit a PR downstream to update AsciidoctorJ reveal.js version
384+
** Modify `gradle.properties`, `asciidoctorj-revealjs/gradle.properties` and `asciidoctorj-revealjs/build.gradle` in: https://github.com/asciidoctor/asciidoctorj-reveal.js
299385

300386
== Ruby and asciidoctor-doctest tests
301387

@@ -324,3 +410,23 @@ This is done using the following command:
324410

325411
Files in the `examples/` directory are used as tests.
326412
Resulting slides are kept in `test/doctest/`.
413+
414+
415+
== Netlify Integration
416+
417+
On every commit or PR, the https://www.netlify.com[Netlify] service will convert some examples into slides and host the resulting pages on its platform where it will be visible by anyone.
418+
It hosts the converted HTML files, reveal.js framework and static content like images and CSS.
419+
This integration will allow us to easily preview PRs and demo features to users (source and converted result).
420+
See the `publish` rake task in `Rakefile` and the `netlify.toml` configuration file.
421+
422+
=== Sensitive Data Accidentally Pushed Out
423+
424+
Only content that is copied into the `public/` directory will be published on the Netlify site.
425+
If, by accident, something sensitive is copied over there, delete it, rewrite the git history to remove the sensitive information and force push the branch.
426+
Reach out to our netlify integration contact to make sure that deployed branches were rebuilt and no longer contain the sensitive information.
427+
428+
=== Integration Contact
429+
430+
Main Contact: https://github.com/Mogztter[@Mogztter]
431+
432+
Also, in order to stay with a free plan, only the following people have control over our netlify integration: https://github.com/Mogztter[@Mogztter], https://github.com/mojavelinux[@mojavelinux] and https://github.com/graphitefriction[@graphitefriction].

docs/asciidoctor-reveal.js-master/LICENSE.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
.The MIT License
22
....
3-
Copyright (C) 2012-2018 Olivier Bilodeau, Charles Moulliard, Dan Allen and the Asciidoctor Project
3+
Copyright (C) 2012-2020 Olivier Bilodeau, Charles Moulliard, Dan Allen and the Asciidoctor Project
44
55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

0 commit comments

Comments
 (0)